LuaLS / LuaLS/lua-language-server
Request for ability to skip adding to documentation, i.e. `---@nodoc`
未關閉
還沒有人認領這個 Issue。
question
- 主要語言
- Lua
- 星號
- 4.4k
- 分支
- 442
- PR 合併指標
- 30 天內沒有已合併 PR
描述
At the moment, if I do anything that references _G, all of the documentation for _G populates the documentation. It would be nice to be able to prevent superfluous documentation - especially for stuff that's only local to the file and not exported for public use.
貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
研究方向
先追蹤檔案參照 _G 時文件是如何收集的，接著找出可以在哪裡辨識 ---@nodoc 標記。完成的條件是：可以將區域符號或其他非公開符號從產生的文件中排除，而不移除公開符號的文件；此 issue 未列出檔案或測試，因此必須先找到這些進入點。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- lua
- 領域
- documentation
- Issue 類型
- 功能
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100