LDoc

LDoc

LDoc är ...
LDoc är en dokumentationsgenerator som är avsedd att vara kompatibel med och följer således mönstret som ställts in av de olika Doc-verktygen: --- Sammanfattning slutar med en period.- En del beskrivning kan vara över flera rader.- @param p1 första parameter - @param p2 andra parameter - @ return ett strängvärde - @ se second_fun funktion mod1.first_fun (p1, p2) slut Taggar som se och användning stöds, och i allmänhet namnen påfunktioner och moduler kan härledas från koden.LDoc är utformad för att ge bättre diagnostik: om en @see-referens inte kan hittas, anges referensraden.LDoc känner till moduler som inte använder modul ().Detta är viktigt eftersom denna funktion har försvunnit i Lua 5.2.Och du kan undvika att behöva bädda in HTML i kommandon genom att använda Markdown.LDoc kommer också att arbeta med Lua C-tilläggskod och ger några praktiska genvägar.
ldoc

kategorier

Alternativ till LDoc för Python

Sphinx

Sphinx

Sphinx är ett verktyg som gör det enkelt att skapa intelligent och vacker dokumentation, skriven av Georg Brandl och licensierad under BSD-licensen.