3

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

特別な意味がありますか？

4

2 に答える 2

9

Lua for Windowsで配布されているSciTEエディターは、これを自動コメント機能のマーカーとして使用します。

ブロックを選択して、メニューから[編集/ブロックコメントまたはコメント解除]を選択する--~と、行の先頭に追加されます。同様に、コメント解除はそれを削除します。ただし、がある場合は--、メニューオプションを選択すると、これはコメントとして認識されず、独自のコメントが追加されます--~。

私はそれが重要ではないと仮定しました、それはSciTEエディターが解析するための単なるマーカーです。RBerteigが指摘しているように、 LuaDocにとって特別な意味はありません--~。それ以外の点では、Lua自体に対する他のコメントと同じです。

于 2011-08-04T11:06:48.780 に答える
3

どうやらそうではありません。

Lua for Windowsに含まれているバージョンのLuaDocの実装を調べると、フォームのコメントが、コメント--~で始まるLuaDocコメントブロックの追加行以外のものとしてパーサーによって認識される場合はないようです。 ---。

つまり、で始まるコメント--~はドキュメントコメントブロックを継続できますが、ドキュメントコメントブロックを導入できない可能性があります。

追加のコンテキストがないと、これがタイプミスなのか、チルダがダッシュに変更されるまで無視されるほぼ正しいLuaDocコメントを残す方法なのかを推測するのは困難です。後者の解釈は、そのようにマークされた関数がボイラープレートテンプレートのように見える場合にもっともらしいです。その場合、テンプレートをコピーして貼り付けて使用するときに、コメントを修正して、LuaDocの後続の実行で表示できるようにする必要があります。

于 2011-08-03T23:02:15.617 に答える