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

[Sebastian Nohn]

Roland Schmid wrote:

> 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?

Mal am Beispiel eines SEHR kleinen Projekts unter 1000 Zeilen Code 
(inkl. Quelltextdoku). Etwa 10% der Quelltextzeilen sind Dabei 
Inline-Dokumentation, die erst mit den knapp 80 Seiten "richtige" 
Dokumentation wie Vorstudie, Fachkonzept, DV-Konzept, 
Testfalldokumentation usw. Sinn ergeben.
Algorithmen, Vorgehensweisen etc. sind alle bereits VORHER festgelegt 
worden und gut genug, das man auch einen mit der eigentlichen Materie, 
aber einer Programmiersprache mächtigen Affen an das Tippen des 
Quelltextes hätte setzen können.

> Kann es im Falle eines Rechtstreits an den Kommentaren liegen, daß ein
> Auftraggeber nicht bezahlen will?

Ja. Wenn vorher irgendwas zu Kommentaren, Dokumentation etc. vereinbart 
wurde. Vorsicht: Auch wenn irgendwo von "Nachvollziehbarkeit" die Rede 
ist, musst du sehr detailliert dokumentieren. Ist irgendwo von 
"Einhaltung von ISO 900x" die Rede? Dokumentieren!

MfG, Sebastian Nohn
-- 
sebastian nohn - wismarer Str. 22 - 53757 sankt augustin - germany
mobile: +49 170 4718105 email: sebastian at nohn.net web: http://nohn.net
did i help you? consider a gift: http://wishlist.nohn.net/
pgp/gpg encrypted mail welcome: http://nohn.net/pubkey.asc