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.
Stronie internetowej:
http://stevedonovan.github.io/ldoc/Kategorie
Alternatywy dla LDoc dla C++
3
GhostDoc
Uprość swoje komentarze XML!GhostDoc to rozszerzenie Visual Studio, które automatycznie generuje komentarze dokumentacji XML dla metod i właściwości na podstawie ich typu, parametrów, nazwy i innych informacji kontekstowych.
- Freemium
- Windows
- C++
- Microsoft Visual Studio