Lua 注释 --~答案

【问题标题】：Lua comment --~Lua 注释 --~
【发布时间】：2011-08-03 16:20:24
【问题描述】：

我知道LuaDoc 在 cmets 的第一行使用“---”，如下所示：

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

但是我在 cmets 的开头看到了这一点：

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

有什么特殊含义吗？

【问题讨论】：

哎呀。删除了我的答案，因为我没有看到第二个代码中的那个是“dash dash tilde”而不是“dash dash dash”。我倾向于认为这是一个错字，但如果没有上下文就很难说。
你在哪里见过“--~”在野外使用？我在 LuaDoc 文档中没有看到对它的任何引用。另外，我已将 LUA 更正为 Lua。 Lua 不是首字母缩写词，它是专有名词。
请注意，LuaDoc 并不是唯一可用的工具。也许您的代码假设会使用其他东西？

标签： lua luadoc

【解决方案1】：

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

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

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

【讨论】：

这实际上是正确的答案。代码是由 Scite Windows 的业余爱好者编写的，所以我假设他只是认为所有 cmets 都应该用 --~ 而不是 --
+1。 SO总是欢迎使用新信息添加另一个答案。当你在这里所做的新答案揭示了一个谜团的实际起源时，更是如此。我已经对其进行了编辑以修复格式怪癖，并引用了对 Lua 或 LuaDoc 没有其他含义的习语。

【解决方案2】：

显然不是。

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

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

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

【讨论】：