Při vytváření JavaScriptových aplikací se každý snadno dostane do stavu, kdy se stává kód každou další hodinou čím dál víc nepřehledný. Nejjednodušším řešením, jak se takovým stavům vyhnout, je komentování kódu. Stejně jako jiné programovací jazyky, i JavaScript se dá jednoduše a celkem efektivně komentovat pomocí anotací. Komentuji své kódy pomocí jsDoc3, ale vygenerovaná dokumentace se mi ani trochu nelíbila a postrádala vlastnosti, které v dokumentaci prostě potřebuji - zobrazení zděděných metod, možnost zobrazit jen veřejné nebo privátní metody a také příjemný vzhled.
Po vzoru skinu pro Adminer 4 jsem se rozhodl, že si napíšu vlastní šablonu pro jsDoc3, na kterou se bude dát koukat :-)
Ukázka
Vygenerovanou dokumentaci je možné si prohlédnout v ukázce.
Stažení
Šablonu je možné stáhnout z mého GitHubu v repozitáři jsdoc3-template.
Náhled vygenerované JavaScript API dokumentace
Zdrojový kód pro vygenerování kódu byl převzat a upraven ze stránky o objektovém programování v JavaScriptu.