Луа комментарий -~

Question

Я знаю, что 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

это имеет особое значение?

Answer 1

Редактор SciTE, поставляемый с Lua для Windows, использует это в качестве маркера для автоматического средства комментирования.

Попробуйте выбрать блок и выберите "Редактировать / Комментарий к блоку или Раскомментировать" из меню, это добавляет --~ в передней части линии. Точно так же Uncomment удаляет его. Однако если у вас просто есть --, затем выберите пункт меню, он не распознает это как комментарий, и добавляет свой собственный комментарий --~,

Я предположил, что это не имеет значения, это просто маркер для разбора редактором SciTE. Как отметил Р.Бертайг, особого значения --~ LuaDoc, и в остальном это просто комментарий, как и любой другой комментарий к самому Lua.

Answer 2

Очевидно нет.

Проверка реализации версии LuaDoc, включенной в Lua для Windows, показывает, что, по-видимому, не было ни одного случая, когда бы комментарий формы --~ воспринимается его синтаксическим анализатором как что-либо кроме дополнительной строки блока комментариев LuaDoc, который начинается с --- комментарий.

То есть возможно, что комментарий начинается с --~ может продолжить блок комментария к документации, но не может ввести блок комментария к документу.

Без дополнительного контекста трудно догадаться, была ли это опечатка или способ оставить почти правильный комментарий LuaDoc, который будет игнорироваться, пока тильда не изменится на тире. Последнее толкование правдоподобно, если контекст сделал функцию, помеченную таким образом, как шаблон котельной пластины. В этом случае, когда шаблон копируется и вставляется для использования, можно ожидать, что исправят комментарий, чтобы сделать его видимым для последующих запусков LuaDoc.