Description

LDoc es el generador de documentación Lua destinado a ser compatible con LuaDoc y, por lo tanto, sigue el patrón establecido por las diversas herramientas de Doc:

--- El resumen finaliza con un punto.
- Algunos la descripción puede estar sobre varias líneas.
- @param p1 primer parámetro
- @param p2 segundo parámetro
- @servir un valor de cadena
- @see second_fun
function mod1.first_fun (p1, p2)
end

Se admiten etiquetas como ver y usar, y generalmente los nombres de funciones y módulos se pueden inferir del código.

LDoc está diseñado para dar mejor resultado. diagnóstico: si no se puede encontrar una referencia @see, se da el número de línea de la referencia. LDoc conoce los módulos que no utilizan el módulo (). Esto es importante ya que esta función ha quedado en desuso en Lua 5.2. Y puede evitar tener que incrustar HTML en los comentarios usando Markdown.

LDoc también funcionará con el código de extensión Lua C, y proporciona algunos accesos directos convenientes.

Categorías