LDoc
💻
LDoc
软件描述
LDoc 是一个 Lua 文档生成器，旨在与 LuaDoc 兼容，因此遵循各种 Doc 工具设定的模式：
官方网站
访问软件的官方网站了解更多信息
stevedonovan.github.io
安全链接HTTPS
什么是 LDoc?
LDoc 是一个 Lua 文档生成器，旨在与 LuaDoc 兼容，因此遵循各种 Doc 工具设定的格式：
--- 摘要以句号结束。
-- 一些描述，可跨越多行。
-- @param p1 第一个参数
-- @param p2 第二个参数
-- @return 字符串值
-- @see second_fun
function mod1.first_fun(p1,p2)
end
支持 see 和 usage 等标签，通常函数和模块名称可从代码中推断。
LDoc 设计为提供更好的诊断信息：若找不到 @see 引用，则会给出引用的行号。LDoc 了解那些未使用 module() 的模块，这一点很重要，因为该函数在 Lua 5.2 中已被弃用。此外，可通过使用 Markdown 避免在注释中嵌入 HTML。
LDoc 还可用于 Lua C 扩展代码，并提供一些便捷的快捷方式。