richtig kommentieren

[balufreak]

guten morgen allerseits

ich habe mir da mal eine frage gestellt. und zwar habe ich schon mehere php seiten gemacht. aber der code ist zum teil recht unübersichtlich. im internet habe ich mal gesucht, wie man php dateien eigentlich kommentiert/dokumentiert. so mit header und so. hab aber nichts schlaues gefunden, bzw. bin nicht auf einen standard gestossen. nun wollte ich mal fragen, wie dokumentiert/kommentiert ihr eure php dateien so? was schreibt ihr in die header, wie kommentiert man klassen, dass sie z.B von Zend Studio oder Eclipse erkennt werden usw.

Greets balu

 

[koli.bri]

Also ich kommetiere fast alles damit, was es macht.

Am Anfang der Datei kommt der Dateiname, und der Zweck der Datei, eventuell was sie darf und was nicht.
Funktionen bekommen die Parameter als Kommentar.
Im Grunde so, dass, wenn ich den eigentlichen Code weglasse, dass ich imer noch genau weiß, was die Datei macht

Wegen Eclipse und Zend-Konformer Kommentation:
Ich würd mal gucken, die die beiden das von Haus aus machen, und mir das quasi abschauen...

 

[wegus]

Gib Deine Klasse kommentarlos jemand Anderem! Wenn er damit arbeiten kann war der Kommentar gut

Jede Datei muß einen header haben ( Name, Beschreibung, Author, Besonderheiten, History). Jede Methode muss eine Kurzbeschreibung besitzen, ebenfalls ein Datum und eine History. Parameter und Return.Werte müssen beschrieben sein.

Gute Dokumentation ist maschinell extrahierbar!

 

[balufreak]

ich hab' jetzt auch noch ein etwas schlauen link gefunden.
http://www.goldmann.de/php-quelltext-dokumentieren_tipp_199.html
werde mich mal ein bisschen daran halten.