lua - Lua 注释 --~

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

它有什么特殊含义吗？

score 9 · Accepted Answer

与 Lua for Windows 一起分发的 SciTE 编辑器使用它作为其自动注释工具的标记。

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

我假设它没有意义，它只是 SciTE 编辑器解析的一个简单标记。正如RBerteig 所指出的，对LuaDoc没有特殊意义，--~否则它就像对Lua 本身的任何其他注释一样。

score 3 · Accepted Answer

显然不是。

检查Lua for Windows中包含的 LuaDoc 版本的实现表明，--~除了以注释开头的 LuaDoc 注释块的附加行之外，似乎没有任何情况下表单的注释被其---解析器注意到.

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

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

2 回答 2