LuaLS / LuaLS/lua-language-server

Can't export documentation for functions

未关闭
#2,015 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

enhancement
主要语言
Lua
星标
4.4k
派生
442
PR 合并指标
30 天内没有已合并 PR

描述

I created a file with this content:

-- Test comment.
---@param x number
---@return number
return function(x)
  return x*2
end

Then I tried to export documentation from that file following this instruction, but got empty files in the output.

Classes are exported successfully, but how to export functions I do not understand.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 Export Documentation wiki 指令开始,并使用报告中的 Lua 示例重现该问题。比较函数情况与成功导出的类情况,并确定输出文件为空的原因;当已记录文档的函数产生非空的导出输出时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
lua
领域
documentation, tooling
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
38/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。