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