YUI Doc pro generování javascriptové dokumentace
Nálepky:
YUI Doc je nástroj napsaný v Pythonu, který vám vygeneruje dokumentaci k vaší javascriptové knihovně. Stejně jako podobné nástroje využívá metainformací vložených do komentářů. Jak vypadá vygenerovaný výstup se můžete podívat na dokumentaci YUI frameworku. YUI Doc je ke stažení ve verzi 1.0 beta. (Zdroj: YUI blog)
Martin Hassman
Martin Hassman založil a řadu let vedl magazín Zdroják, absolvoval VŠCHT Praha, pořádal řadu konferencí, pomáhal s rozšířením otevřených technologií, byl u založení projektů CZilla, Dáme roušky a dalších. Vymyslel a dva roky vedl dobrovolnický projekt Movapp pod Česko.Digital. Nyní pracuje jako produktový manažer v datové platformě Golemio.cz.
… když si představím, jak různě je možné v js udělat třídu a balíčky, říkám si, že to asi nebude jednoduchý nástroj. Anebo nutí "ten jediný správný" způsob, zvlášť, když v js jsou v oop spíše způsoby špatné a ještě horší, co jsem viděl.
A co třeba kompromis? Podporovat několik základních zápisů by nemusel být takový problém. Klasické pravidlo 80/20. V Yahoo mají svůj styl kódování (kdo zná přednášky od Douglase Crockforda asi tuší), tak minimálně ten bude podporován.
Takže implementovat to nejpoužívanější… jo, i pesimista asi musí uznat, že je to lepší, než nedokumentovat. Postihnout vše by byl celkem problém.
V JS si nedovedu dobře představit jednotný styl kódování, když každý má své výhody, které bohužel je problém kombinovat. Ale dobře, v Yahoo jsou asi v js poněkud zkušenější, než já. Až se rozhodnu oprášit js, tak se na Yahoo asi podívám.