Lua注释：--~

2013-7-6 10:36:51
收藏：0
阅读：145
评论：2

我知道 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

它有特殊的含义吗？

原文链接 https://stackoverflow.com/questions/6929766

点赞
stackoverflow用户68204
stackoverflow用户68204

似乎不是这样的。

检查 Lua for Windows 中包含的 LuaDoc 版本的实现，我们发现没有一个情况是 --~ 形式的注释被解析器识别为其他类型的内容，除了一个已经以 --- 开头的 LuaDoc 注释块的另一行。

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

如果没有更多的上下文，很难猜测这是一个打字错误还是一种方法，可以将一个几乎正确的 LuaDoc 注释留下来，直到波浪线被改成破折号才会被处理。如果上下文将这种被标记为模板的函数看作是样板模板，那么后一种解释是合理的。在这种情况下，当该模板被复制和粘贴以供使用时，预计需要修复注释以使它在之后的 LuaDoc 运行中可见。

2011-08-03 23:02:15
stackoverflow用户416047
stackoverflow用户416047

Lua for Windows 附带的 SciTE 编辑器使用这个作为自动注释工具的标记。

尝试选择一个块并从菜单中选择 “Edit/Block Comment or Uncomment”，它会在行的前面添加 --~。同样地，Uncomment 则会将其移除。然而，如果你只有 --，然后选择菜单选项，它不会将其识别为注释，并添加它自己的注释 --~。

我认为它没有什么重要性，只是 SciTE 编辑器用于解析的一种简单的标记。正如 RBerteig 所指出的那样，--~ 对 LuaDoc 没有特殊的意义，对于 Lua 本身来说，它只是像其他注释一样。

2011-08-04 11:06:48

作者:

stackoverflow用户796584

stackoverflow用户796584
推荐文章