Dokumentation von Dateien

[compuboy1010]

Guten Tag,

bei Klassen ist es ja üblich im Kopf einen Komentarblock anzugeben.
Wer hat programmiert, wann, Version,etc,etc,etc

Das Beispiel in der Programmiertdoku zu den Standards von PEAR finde ich nicht so gut.

Was sollte alles vorkommen ?

Macht man das eigentlich nur mit Klassen oder auch mit normalen php Dateien ? Wenn ja, wie ausführlich sollten die sein ?


Danke

[schmalle]

ich verschieb dir mal ...

[jochenj]

bin zwar kein profi, aber ich handhabe das meistens so:

nicht das "wie", sondere das "was" der code macht dazuschreiben.
so knapp wie möglich, aber so ausführlich das auch ein dritter versteht, was da passiert.
eine einheitliche linie im code beibehalten (wenn die erklärung vor dem codeblock ist, dann immer vor dem codeblock)

alles andere (wie z.b. name des programmieres etc.) ist sicherlich sinnvoll, aber das sollte man auch nicht übertreiben.