LDoc jest generatorem dokumentacji, który ma być zgodny, a zatem podąża za wzorcem ustawionym przez różne narzędzia Doc: --- Podsumowanie kończy się kropką.- Niektóre opisy mogą zawierać kilka wierszy.- @param p1 pierwszy parametr - @param p2 drugi parametr - @zwróć wartość ciągu - @ patrz funkcja second_fun mod1.first_fun (p1, p2) koniec Tagi, takie jak patrz i użycie są obsługiwane, i ogólnie nazwyfunkcje i moduły można wywnioskować z kodu.LDoc został zaprojektowany w celu zapewnienia lepszej diagnostyki: jeśli nie można znaleźć odniesienia @ patrz, podaje się numer wiersza odwołania.LDoc wie o modułach, które nie używają module ().Jest to ważne, ponieważ ta funkcja stała się przestarzała w Lua 5.2.I możesz uniknąć konieczności osadzania HTML w poleceniach, używając Markdown.LDoc będzie również działać z kodem rozszerzenia Lua C i zapewnia kilka wygodnych skrótów.
ldoc
Stronie internetowej:
http://stevedonovan.github.io/ldoc/Kategorie
Alternatywy dla LDoc dla Self-Hosted
16
Slate API Docs Generator
Łupek - piękna dokumentacja statyczna dla Twojego API
- Darmowa
- Self-Hosted
- Mac
- Linux
12
Daux.io
Daux.io to generator dokumentacji, który wykorzystuje prostą strukturę folderów i pliki Markdown do tworzenia niestandardowej dokumentacji w locie.Pomaga tworzyć świetnie wyglądającą dokumentację w sposób przyjazny dla programistów.
- Darmowa
- Self-Hosted
4
Codex
Codex to prosta oparta na plikach platforma dokumentacji Markdown zbudowana na Laravel.Jest całkowicie konfigurowalny i bardzo prosty w użyciu, aby stworzyć piękną dokumentację.
- Darmowa
- Self-Hosted