Ktory "projekt" byste odporucili na zdokumentovanie PHP kodu?

9. 11. 2016 15:19:24

Ahojte,

ktory "projekt" by ste odporucili na zdokumentovanie PHP kodu, respektive vytvorenie dokumentacie z kodu?

Aktualne pozeram na Sami kvoli tomu ze ho pouziva symfony(=kvalitka) ale nemam ziadnu preferenciu a zaujimalo by ma co teraz najviac frci.

9. 11. 2016 15:19:24

https://webtrh.cz/diskuse/ktory-projekt-byste-odporucili-na-zdokumentovanie-php-kodu/#reply1236150

(20 hodnocení)

9. 11. 2016 15:24:26

ja pouzivam na PHP PHPDoc uz proto, ze ho PHP Storm i jina IDE umi castecne generovat automaticky... A taky pouzivat pak jeho vystupy pri naseptavani, kontrole dat apod.

9. 11. 2016 15:24:26

https://webtrh.cz/diskuse/ktory-projekt-byste-odporucili-na-zdokumentovanie-php-kodu/#reply1236149

ViPErCZ

(21 hodnocení)

9. 11. 2016 16:34:51

Defacto to je jedno... PHPDoc ci defacto jen komentare... bez toho si snad ani neumim dnes predstavit profi zdrojak. Nehlede na to jak pise Ales, IDE to pouzivaji na zjednoduseni prace programatora.

Pro PHP bych pouzil APIgen.

9. 11. 2016 16:34:51

https://webtrh.cz/diskuse/ktory-projekt-byste-odporucili-na-zdokumentovanie-php-kodu/#reply1236148

David Musil

(69 hodnocení)

9. 11. 2016 17:20:03

Nedavno jsem videl prednasku jednoho programatora, ktery sam sebe povazoval za opravdoveho profika. Na mel delal dojem PHP guru.

Rikal, ze pokud programator mysli a pojmenuje tridy, funkce a promenne logicky a podle toho co delaji a nepise kod jako prase, nemusi byt komentare v kodu.

Nejake nazory na to? :)

9. 11. 2016 17:20:03

https://webtrh.cz/diskuse/ktory-projekt-byste-odporucili-na-zdokumentovanie-php-kodu/#reply1236147

(20 hodnocení)

9. 11. 2016 17:44:19

Tak samozřejmě je ideální vyvarovat se pouzivani zbytečných zkracenin nebo uplne náhodných nazvu, je ideální dodržovat nějaký styl pojmenovavani (pouzivam camel case), je ideální psát anglicky, na druhou stranu bez komentovani kódu pridelavas praci i sám sobě do budoucna, já často taky nevím proč sem něco udělal tak jak sem to udělal, komentář či jen zmínka v popisu fce s pochopením vyznamne pomáhá... Navíc phpdoc není jen komentář, tam rovnou píšeš i popisky k argumentum a k tomu co fce vraci apod. Abys vždy věděl i v budoucnu co do té fce má přijít a jak se k tomu bude chovat. To vše ti pak IDE vypise když tu fci pouzivas takže to pak vis aniž bys ten soubor s ni někdy viděl... Takže ano, má pravdu... Ale ne tak úplně

9. 11. 2016 17:44:19

https://webtrh.cz/diskuse/ktory-projekt-byste-odporucili-na-zdokumentovanie-php-kodu/#reply1236146

ViPErCZ

(21 hodnocení)

10. 11. 2016 08:56:14

Nedá se to brát úplně doslova. Dovedu si představit jednoduchou appku, kterou napises podle jeho doporuceni a komentare jsou k nicemu a kdyz to otevres za dvacet let, tak to pochopis i bez nich okamzite. Treba zrovna v PHPecku je super psat komentare, hlavne trid a funkci uz jen proto, ze si treba nejakym nastrojem budes chtit vygenerovat dokumentaci. Nebo zrovna v tomhle jazyku muzes vyuzit reflekci. Konvence psani kodu s maximalni prenositelnosti je urcite dobre dodrzovat, coz potvrzuje to pravidlo, o kterem mluvil a to neprasit. Ostatne sami autori takovych krasnych veci jako strstr treba v phpku. Mne osobne nazev takovehle funkce vubec nic nerika. Maximalne, ze to je dobre na neco s retezci :-) Nekdy proste to co funkce dela popsat do nejakeho normalne dlouheho nazvu cini velke obtize. Rozepsat se ve trech vetach v komentari je pak daleko jednodussi a clovek tomu i rychleji rozumi nez lustit nejaky algoritmus v tele. Navic kdyz me defacto nemusi ani zajimat jak to ta funkce del, ale jde mi jen o pouzitelnost a vysledek.

10. 11. 2016 08:56:14

https://webtrh.cz/diskuse/ktory-projekt-byste-odporucili-na-zdokumentovanie-php-kodu/#reply1236145

Martin Schlemmer

(36 hodnocení)

10. 11. 2016 15:50:41

Správné názvy řeknou, co se v kódu děje.

Komentáře vysvětlí, proč se to tak děje.

10. 11. 2016 15:50:41

https://webtrh.cz/diskuse/ktory-projekt-byste-odporucili-na-zdokumentovanie-php-kodu/#reply1236144

Pro odpověď se přihlašte.

Přihlásit