LDoc

LDoc

LDoc ist ...
LDoc ist ein Dokumentationsgenerator, der kompatibel sein soll und daher dem von den verschiedenen Doc-Tools festgelegten Muster folgt: --- Zusammenfassung endet mit einem Punkt.- Einige Beschreibungen können sich über mehrere Zeilen erstrecken.- @param p1 erster Parameter - @param p2 zweiter Parameter - @return a string value - @see second_fun function mod1.first_fun (p1, p2) end Tags wie see und usage werden unterstützt und generell die Namen vonFunktionen und Module können dem Code entnommen werden.LDoc wurde entwickelt, um eine bessere Diagnose zu ermöglichen: Wenn eine @ see-Referenz nicht gefunden werden kann, wird die Zeilennummer der Referenz angegeben.LDoc kennt Module, die module () nicht verwenden.Dies ist wichtig, da diese Funktion in Lua 5.2 veraltet ist.Mit Markdown können Sie außerdem das Einbetten von HTML in Kommentare vermeiden.LDoc funktioniert auch mit Lua C-Erweiterungscode und bietet einige praktische Verknüpfungen.
ldoc

Kategorien

LDoc-Alternativen für C++

GhostDoc

GhostDoc

Vereinfachen Sie Ihre XML-Kommentare!GhostDoc ist eine Visual Studio-Erweiterung, die automatisch XML-Dokumentationskommentare für Methoden und Eigenschaften generiert, basierend auf Typ, Parametern, Namen und anderen Kontextinformationen.