Lua语言服务器中@see注解的换行问题分析与解决方案

问题背景

在Lua语言服务器项目中，开发者发现了一个关于文档注释渲染的问题。当使用@see注解时，无论注释中是否包含空行，注解内容都会与前一行非空注释内容显示在同一行上，这与开发者期望的换行显示效果不符。

问题现象

考虑以下Lua代码示例：

---comment
---
---@see foo
function bar() end

开发者期望在悬停查看bar函数时，"see foo"应该显示在"comment"的下一行。然而实际效果是两者会显示在同一行上，中间的空白行被忽略。

技术分析

经过深入代码分析，发现问题根源在于函数注释的处理方式：

1. 函数注释的分段处理：对于函数，注释内容(comment)和@see注解实际上是分开处理的两个独立部分

   • 注释部分由getFunctionComment函数处理
   • @see部分则由lookUpDocComments和lookUpDocSees函数处理

2. Markdown转换问题：在getFunctionComment函数中，注释内容被转换为Markdown格式后，通过md:string()方法提取字符串，这个方法会自动去除尾部的空行

3. 拼接处理：最终，处理后的注释字符串与@see部分的Markdown字符串简单拼接，导致两者显示在同一行

有趣的是，这个问题仅出现在函数注释中，对于变量注释却能正常工作：

---comment
---
---@see foo
local bar

这是因为变量注释是作为一个整体处理的，中间的空白行得以保留。

解决方案

经过技术分析，提出了以下改进方案：

1. 修改函数返回值：将getFunctionComment函数重命名为getFunctionMarkdown，并直接返回Markdown对象而非字符串
2. 外部处理合并：让外层调用者统一处理Markdown对象，保持注释和注解的整体性

具体代码修改包括：

• 修改getFunctionMarkdown函数，返回Markdown对象而非字符串
• 调整tryDocComment函数，直接使用返回的Markdown对象

临时解决方案

在正式修复前，开发者可以使用HTML的<br>标签强制换行：

---comment
---<br>
---@see foo
function bar() end

技术意义

这个问题的解决不仅修复了文档注释的显示问题，更重要的是：

1. 统一了函数和变量注释的处理流程
2. 保持了Markdown处理的完整性
3. 为未来可能的文档注释扩展提供了更好的基础架构

通过这次修复，Lua语言服务器在文档注释渲染方面更加准确和一致，提升了开发者的使用体验。