LDoc

LDoc

LDoc je ...
LDoc je generátor dokumentace určený k tomu, aby byl kompatibilní s tímto vzorcem nastaveným různými nástroji Doc: --- Shrnutí končí tečkou.- Nějaký popis, může být přes několik řádků.- @param p1 první parametr - @param p2 druhý parametr - @ vrácení hodnoty řetězce - @see second_fun funkce mod1.first_fun (p1, p2) end Značky jako See a Use jsou podporovány a obecně jsou názvyfunkce a moduly lze odvodit z kódu.LDoc je navržen tak, aby poskytoval lepší diagnostiku: pokud nelze najít odkaz @see, pak je uvedeno číslo řádku odkazu.LDoc ví o modulech, které nepoužívají modul ().To je důležité, protože tato funkce byla v Lua 5.2 zastarána.A můžete se vyhnout nutnosti vkládat HTML do závazků pomocí Markdown.LDoc bude také pracovat s doplňkovým kódem Lua C a poskytuje některé pohodlné zkratky.
ldoc

Kategorie

Alternativy LDoc pro Node.JS

swagger.io

swagger.io

Swagger je open source dokumentační nástroj RESTapi.