Nepouzivate nekdo v PHP ThimbleDoc ? V zadnem pripade neni tak „vymakany“ jako PHPDoc, ale zase o to je jednodussi na pouzivani.
Jak napsat dokumentaci k projektu během pár minut?
Na serveru Linuxlinks.com vyšel seznam šesti nejoblíbenějších generátorů dokumentace. Jedná se o nástroj pro snadnou tvorbu dokumentace pro ty, jež nebaví psát je pomocí OpenOffice nebo jiného textového procesoru. V seznamu jsou jak obecné generátory, tak přímo specializované na PHP, Python nebo Javu.
Dále čtěte…
- Jaký programovací jazyk se naučit 7. 1. 2010 16:23
- O'Reilly Open Source Software Convention 2003 16. 1. 2003 9:15
- Prezentace o LAMP řešení Facebooku 16. 4. 2009 9:26
- Python je jazykem roku 2008 16. 2. 2009 15:02
- Sun zaměstnal dva vývojáře Pythonu 5. 3. 2008 14:43
Re: ThimbleDoc
celé vláknoJa si oblibil NaturalDoc… není to sice 2× super a ted to cely bude prepsany do c# tak sem zvedavej… nicmene to co je.. tak vypada docela pekne: http://phpblamework.webjet.cz/…ion-txt.html
Re: Jak napsat dokumentaci k projektu během pár minut?
celé vláknoheezkyyyy. a ja blbec porad datluju dokumentaci rucne :D
Hodnotné informace
celé vláknoVždyť nejvíc práce je stejně s tím, aby člověk vyjádřil hodnotné informace, které má jinak jen v hlavě a zpřístupnil je ostatním formou dokumentace. A s tím ti žádný program nepomůže. Vygenerovat se dají kvanta textu, ale s jakou hodnotou? Tu hodnotu tam musí dát člověk (do komentářů, zvláštních značek atd.)
Ty nástroje samozřejmě smysl mají, používám JavaDoc a Doxygen, ale bohužel řeší jen formátování/transformaci a ne tu fázi, která je pro hodně programátorů „největší vopruz“ :-D tzn. přepis informací z vlastní hlavy někam jinam :-)
Re: Hodnotné informace
celé vláknoTu fazi „přepis informací z vlastní hlavy někam jinam“ ma google ve svem planu na rok 2019. Bude to delat automaticky a transparentne :-)
Paradoxne jsme narazili na jiny problem: dobre dokumentace mame spoustu, ale je ji jiz tolik (jenom text je radove ve stovkach MB), ze je nekdy hodne tezke najit nejakou podrobnost. Taky existuji obcasna „temna zakouti“, ktere nejsou up-to-date nebo nemaji dokumentaci vubec. Vzdy to je o tom presvedcit/donutit lidi (model-checking-style anotace by byly fajn, ale v C++ to nema moc smysl).

