LDoc je generátor dokumentace určený k tomu, aby byl kompatibilní s tímto vzorcem nastaveným různými nástroji Doc: --- Shrnutí končí tečkou.- Nějaký popis, může být přes několik řádků.- @param p1 první parametr - @param p2 druhý parametr - @ vrácení hodnoty řetězce - @see second_fun funkce mod1.first_fun (p1, p2) end Značky jako See a Use jsou podporovány a obecně jsou názvyfunkce a moduly lze odvodit z kódu.LDoc je navržen tak, aby poskytoval lepší diagnostiku: pokud nelze najít odkaz @see, pak je uvedeno číslo řádku odkazu.LDoc ví o modulech, které nepoužívají modul ().To je důležité, protože tato funkce byla v Lua 5.2 zastarána.A můžete se vyhnout nutnosti vkládat HTML do závazků pomocí Markdown.LDoc bude také pracovat s doplňkovým kódem Lua C a poskytuje některé pohodlné zkratky.
ldoc
Webová stránka:
http://stevedonovan.github.io/ldoc/Kategorie
Alternativy LDoc pro všechny platformy s jakoukoli licencí
49
26
21
16
Slate API Docs Generator
Břidlice - krásná statická dokumentace pro vaše API.Features
- Zdarma
- Self-Hosted
- Mac
- Linux
12
Daux.io
Daux.io je generátor dokumentace, který používá jednoduchou strukturu složek a soubory Markdown k vytvoření vlastní dokumentace za běhu.Pomáhá vám vytvářet skvěle vypadající dokumentaci vývojářským způsobem.
- Zdarma
- Self-Hosted
11
Presidium
Presidium je systém správy softwarové dokumentace pro agilní týmy a jejich uživatele, vyrobený z běžně používaných komponent open source.
- Zdarma
- Mac
- Linux
- GitHub Pages
6
5
Sandcastle
Společnost Sandcastle vytváří přesnou, MSDN styl, komplexní dokumentaci tím, že odráží zdrojové sestavy a případně integruje komentáře XML k dokumentaci.
- Zdarma
- Windows
- .NET Framework
4
NDoc
NDoc generuje dokumentaci knihoven tříd .NET a soubory XML dokumentace generované kompilátorem C # (nebo pomocí doplňkového nástroje pro VB.NET).
- Zdarma
- Windows
- .NET Framework
4
Codex
Codex je jednoduchá dokumentační platforma Markdown založená na souboru Laravel.Je to zcela přizpůsobitelné a mrtvé jednoduché použití k vytvoření krásné dokumentace.
- Zdarma
- Self-Hosted
3
GhostDoc
Zjednodušte své komentáře XML!GhostDoc je rozšíření Visual Studio, které automaticky generuje komentáře k dokumentaci XML pro metody a vlastnosti na základě jejich typu, parametrů, názvu a dalších kontextových informací.
- Freemium
- Windows
- C++
- Microsoft Visual Studio
3
2
1
Document! X
Dokument!X je kombinace automatizovaného dokumentačního nástroje a úplného vývojového prostředí, které lze použít k vytvoření, publikování a údržbě přesné, profesionální dokumentace kvality pro .NET, webové služby, databáze, XSD, Java, Javascript.
