LuaLS / LuaLS/lua-language-server
How to annotate default arguments to parameters
未关闭
还没有人认领这个 Issue。
- 主要语言
- Lua
- 星标
- 4.4k
- 派生
- 442
- PR 合并指标
- 30 天内没有已合并 PR
描述
Is there a standard way to annotate default arguments? I believe in LDoc you can do:
-- @string[opt='gregorian'] calendar optional calendar
-- @int[opt=0] offset optional offset
I'm currently converting some docs over and couldn't find anything in the wiki.
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
先从项目的 wiki 和现有的注解文档开始，然后将其支持的语法与 issue 中的 LDoc 示例进行比较。记录表达默认参数的标准方式，或明确说明该语法不受支持，以便转换文档的用户能够确定正确的注解。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- lua
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100