Luaのコメント - 〜

Question

私はこのようなコメントの最初の行にLuaDoc用途が "---" を知っている：

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

：私は、コメントの最初にこれを見ただし

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

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

Answer 1

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

ブロックを選択し、メニューから[コメント/コメントの編集/ブロックを解除]を選択すると、行頭に--~が追加されます。同様にコメントを外すとコメントが削除されます。しかし、あなたがちょうど--を持っているなら、これをコメントとして認識しないメニューオプションを選択し、それ自身のコメント--~を追加します。

私はそれが意味を持たないと仮定しました。これは、SciTEエディタが解析するための簡単なマーカーです。 RBerteigで指摘されているように、LuaDocには--~という特別な意味はありません。そうでなければ、Lua自体のようなコメントにすぎません。

Answer 2

明らかにそうではありません。 Lua for Windowsに含まLuaDocのバージョンの実装の

検査は、フォーム--~のコメントが始まったLuaDocコメントブロックの追加行以外としてのパーサで注目されているいかなる場合はないようであることが明らかになりました---コメントあり。

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

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