Wir haben eine Liste von 27 kostenlosen und kostenpflichtigen Alternativen zu LDoc zusammengestellt. Zu den Hauptkonkurrenten gehören Doxygen, swagger.io. Neben diesen vergleichen Benutzer auch LDoc mit Natural Docs, Sphinx, Daux.io. Außerdem können Sie hier auch andere ähnliche Optionen ansehen: Entwicklungs-Tools.
Wir haben eine Liste von 27 kostenlosen und kostenpflichtigen Alternativen zu LDoc zusammengestellt. Zu den Hauptkonkurrenten gehören Doxygen, swagger.io. Neben diesen vergleichen Benutzer auch LDoc mit Natural Docs, Sphinx, Daux.io. Außerdem können Sie hier auch andere ähnliche Optionen ansehen: Entwicklungs-Tools.
LDoc ist Lua- Dokumentationsgenerator, mit dem kompatibel sein soll LuaDoc und folgt damit dem von den verschiedenen Doc-Tools festgelegten Muster:
--- Zusammenfassung endet mit einem Punkt. - Einige Beschreibungen können sich über mehrere Zeilen erstrecken. - @param p1 erster Parameter - @param p2 zweiter Parameter - @ einen String-Wert zurückgeben - @see second_fun Funktion mod1.first_fun (p1, p2) Ende
Tags wie see und usage werden unterstützt, und im Allgemeinen können die Namen von Funktionen und Modulen aus dem Code abgeleitet 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.