Question

我知道LuaDoc在第一行评论中使用“---”，如下所示：

--- an example function
-- @param a parameter a desc
-- @param b parameter b desc
function f (a,b)
   --code
   --code
end

但是我在评论开头看到了这一点：

--~ comment for a function
function f (a,b)
   --code
   --code
end

它有特殊意义吗？

Answer 1

与Lua for Windows一起发布的SciTE编辑器将其用作自动评论工具的标记。

尝试从菜单中选择一个块并选择“编辑/阻止注释或取消注释”，它会将--~添加到该行的前面。同样，Uncomment将其删除。但是，如果你只有--，那么选择它不会将其识别为评论的菜单选项，并添加它自己的评论--~。

我认为它没有任何意义，它只是SciTE编辑器解析的简单标记。正如RBerteig所指出的那样，--~对LuaDoc没有特别的意义，否则它只是对Lua本身的任何其他评论。

Answer 2

显然不是。

检查Lua for Windows中包含的LuaDoc版本的实现情况表明，似乎没有任何案例表明{* 1}}形式的注释被其解析器注意为除了附加行以外的任何内容以--~评论开头的LuaDoc评论块。

也就是说，以---开头的注释可能会继续文档注释块，但不会引入文档注释块。

如果没有额外的上下文，很难猜测这是一个错字还是留下几乎正确的LuaDoc注释的方法，直到波浪号变为破折号时才会被忽略。如果上下文使标记的功能看起来像锅炉板模板，则后一解释是合理的。在这种情况下，当复制并粘贴模板以供使用时，应该会修复注释以使其对后续运行的LuaDoc可见。