[php] 1/2 OT: gibt es einen Standard zur Kommentaren im Quellcode

[Robert Hennig]

Roland Schmid wrote:

>Hallo Liste,
>
>ich habe eine Frage zu Kommentaren im Quellcode.
>Im Augenblick habe ich einen Streit mit einem Auftraggeber, der nicht zahlen
>will, weil er behauptet der Quellcode sei nicht ausreichend kommentiert und
>somit f�r dritte nicht nachvollziehbar. Im Lastenheft ist nichts vermerkt
>�ber Vereinbarungen, wie die Kommentare auszusehen haben.
>Meine Frage: Gibts einen Standard wie ein Quellcode kommentiert sein muss?
>W�rde mich interessieren, wie Eure Erfahrungen dar�ber sind?
>Kann es im Falle eines Rechtstreits an den Kommentaren liegen, da� ein
>Auftraggeber nicht bezahlen will?
>
>Aus Respekt vor den Teilnehmern der Liste bitte die Antworten nicht an die
>Liste senden, sondern bitte per PM an php.liste at net-service-24.de
>
>Gruss Roland
>  
>

Hallo Roland!

�ber "offizielle" Standards und Anforderungen ist mir auch nichts 
bekannt. Eine gute M�glichkeit mit den Kommentaren auch gleichzeitig die 
Dokumentation zu erschlagen ergibt sich jedoch wenn man sich an die 
Kommentar-Richtlinien h�lt die von PHPDocumentor 
(http://www.pear.php.net/package/PhpDocumentor) oder dem Java-Tool 
(javadoc? mir f�llt der Name grade nicht ein) gebraucht werden und aus 
denen sich hinterher ohne grossen Aufwand eine Dokumentation generieren 
l�sst..

Gru�

Robert