LuaLS / LuaLS/lua-language-server

Regular comments (i.e. `-- comment`) shouldn't be included in documentation

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

还没有人认领这个 Issue。

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

描述

How are you using the lua-language-server?

NeoVim

Which OS are you using?

MacOS

What is the issue affecting?

Hover

Expected Behaviour
-- THIS IS NOT A DOC COMMENT
---This is a doc comment
local a = ''

Hovering a should show: This is a doc comment.

Actual Behaviour
-- THIS IS NOT A DOC COMMENT
local a = ''

Hovering a shows:

THIS IS NOT A DOC COMMENT
This is a doc comment
Reproduction steps

See above ^^^

Additional Notes

No response

Log File

No response

贡献指南

打开贡献指南

从这里开始

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

调研方向

从 issue 中的 Lua 示例开始,并在 NeoVim 中复现 hover 输出。跟踪 hover 文档的处理过程,以确定为什么普通的 -- 注释会与 --- 注释一起被包含;当 hover a 时只显示 This is a doc comment 即表示完成。

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

评估

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

把新 issue 发到你的邮箱

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