dokumentiranje php-ja

5 naročnikov

mene pa zanima kje bi se našlo kaj literature na temo dokumentacija php-ja

zani ma me predvsem za kaj je pomembna, kaj je potrebno dokumetirati, standardi za pisanje kode (imena spremenljivk, komentarji kode, zamik kode...), ipd...

zanimajo me tudi vaša mnenja o najboljši aplikaciji za kreiranje dokumentacije in pa če je že kdo izdelal svoj lasten sistem za pisanje :)

hvala za odgovore :)

Tole je čist huda zadeva. =)

Standarde si na nek način določaš sam (oziroma se dogovoriš s sodelavci). Sam pri spremenljivkah uporabljam naslednje "prefixe":*sql query (string) - $sql ($sqlEvents)
*query resource - $q ($qEvents)
*query result - $r ($rEvent)
*query count - $c ($cEvents)
*array - $arr
*začasne spremenljivke - $temp
*itd.Važno je, da imaš povsod enak sistem in da ga skozi razvoj ne spreminjaš.

http://en.wikipedia.org/wiki/Codingconventions#Commonconventions

Sicer je najbolj odvisno od okolja, v katerem delaš. Če sistem že uporablja določeno notacijo, jo je najbolje nadaljevati.

Jaz uporabljam Allmanov indent, CamelCase za deklaracijo classov in method, v osnovni sintaksi pa uporabljam večino CodeIgniter praks

S podobnim vprašanjem sem se tudi sam ubadal. Tole so moji top bookmarki na to temo:

http://pear.php.net/manual/en/standards.php
http://framework.zend.com/manual/en/coding-standard.coding-style.html
http://framework.zend.com/wiki/display/ZFDEV/PHP+Coding+Standard+(draft)
http://drupal.org/coding-standards
http://docs.joomla.org/Codingstyleand_standards
http://net.tutsplus.com/tutorials/php/30-php-best-practices-for-beginners/

Zakaj je naslov dokumentiranje php-ja potem pa govorite o standardih kodiranja? :D

Sam dokumentiram v stilu phpdoc-a za generacijo dokumentacije pa potem uporabim DocBlox

drugače pa za kodirat uporablam neko verzijo zend-a in ostalih (bolj neko mešanico ki mi najbolj sede ;) )