DocumentJS pracuje přes příkazovou řádku Node.js a umožňuje vývojářům vytvářet dokumentaci stránek, aniž by museli dělat dvojí nepříjemnou psaní komentářů v jejich kódu a pak vysvětloval později v samostatný soubor HTML.
Web dokumentace je vytvořen pomocí zdrojový kód komentuje sebe, to vše automaticky, pokud vývojáři následovat jednoduchý kód komentáře formátovací pravidla.
DocumentJS podporuje jednoduché struktury a syntaxe Markdown, spolu se schopností vytvářet číslo verze dokumentace, pracovat v synchronizaci s historií správu verzí kodexu.
V případě, že kód komentuje zabírají příliš mnoho místa ve zdroji, které lze exportovat do samostatného souboru Markdown a pak svázaný zpět do původního kódu pomocí jednoduchých značek.
Tato druhá funkce funguje skvěle u větších projektů, kde více než jedna osoba pracuje na kódu a jsou potřeba další podrobnosti do hloubky pro každou funkci, metodu nebo parametru.
.
DocumentJS & nbsp; byl vyvinut jako součást rámcem pro JavaScript - JavaScriptMVC
Vlastnosti
- Flexibilní organizace dokumentaci
- Integrovaný prohlížeč dokumentace, kde můžete vyhledávat vaše API
- Podpora Markdown
- rozšiřitelná architektura,
Komentáře nebyl nalezen