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

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 для разбора.Как отмечает RBerteig , для LuaDoc нет особого значения --~, а в остальном это просто комментарий, как и любой другой комментарий для самого Lua.

Answer 2

По-видимому, нет.

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

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

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