Lua的評論 - 〜

我知道的意見是這樣的一線LuaDoc用途「---」：Lua的評論 - 〜

--- 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

它有特別的意義嗎？

2011-08-03 AlexStack

哎呦。刪除了我的答案，因爲我沒有在第二個代碼中看到這是「短劃線代字符」而不是「短劃線短劃線」。我傾向於認爲這是一個錯字，但很難說沒有語境。 –

你在哪裏見過野外使用的「〜〜」？我在LuaDoc文檔中沒有看到它的任何引用。此外，我已將LUA更正爲Lua。 Lua不是一個縮寫詞，它是一個專有名詞。 – RBerteig

請注意，LuaDoc並不是野外唯一的工具。也許你的代碼假設其他東西會被使用？ –

與Lua for Windows一起發行的SciTE編輯器使用它作爲自動評論工具的標記。

嘗試選擇一個塊並從菜單中選擇「編輯/阻止評論或取消註釋」，它將--~添加到行的前面。同樣，取消註釋將其刪除。但是，如果您只有--，然後選擇菜單選項它不會將其識別爲評論，並添加它自己的評論--~。

我認爲它沒有任何意義，它只是SciTE編輯器解析的一個簡單標記。正如RBerteig所指出的那樣，LuaDoc沒有--~的特殊意義，否則就像Lua本身的其他任何意見一樣。

2011-08-04 11:06:48 daven11

這實際上是正確的答案。該代碼是由Scite Windows中的一名業餘愛好者編寫的，所以我認爲他只是認爲所有的評論都應該用〜而不是 - – AlexStack

+1來寫。在SO中總是歡迎添加新信息的另一個答案。當新的答案揭示了你在這裏所做的一個神祕事件的真正起源時更是如此。我編輯它來修正格式怪癖，並且引用對Lua或LuaDoc沒有其他含義的習語。 – RBerteig

顯然不是。的LuaDoc包括在Lua for Windows版本執行

檢驗表明，似乎沒有哪裏的形式--~的評論是由它的解析器注意到作爲比LuaDoc註釋塊額外的行開始的任何其他情況下與---評論。

也就是說，以--~開始的註釋有可能會繼續文檔註釋塊，但不會引入文檔註釋塊。

沒有額外的上下文，很難猜測這是否是打字錯誤還是留下接近正確的LuaDoc註釋的方式，直到代字號變爲破折號纔會被忽略。如果上下文使功能標記爲鍋爐板模板，則後一種解釋是合理的。在這種情況下，當模板被複制並粘貼以供使用時，可以預期將修改註釋以使其對隨後的LuaDoc運行可見。

2011-08-03 23:02:15 RBerteig

回答