PHPDocs - Sinnvoll?

[ExAByte]

Hallo,
im Rahmen eines Web-Projekts werden Konventionen verlangt, so dass ich auf die PHPDocs gestoßen bin. Meine Frage ist, wo bekomme ich denn eine Dokumentation und Installationshinweise zu den PHPDocs (wie JavaDocs?) und sind diese Sinnvoll? Gibt es defacto Konventionen zur Einrückung, schreibweise etc.?

Danke für eure Diskussions-Beiträge! Bin mal gespannt, was die Menge so denkt.

Gruß

 

[Wolfsbein]

Die Konventionen kannst du im Prinzip selbst festlegen (bzw. der Projektleiter). Festgelegt sind z.B. die PEAR Konventionen: pear.php.net. Und ja das funktioniert genauso wie JavaDocs. Ob es sinnvoll ist musst du selbst entscheiden. Wie groß ist das Projekt und wird es weitergegeben?

 

[JohannesR]

Also ich halte die PEAR-Regeln für etwas sehr gutes und gescheites, so wird Code standartisiert, jeder kann ihn schnell überblicken & lesen, er läuft auf vielen systemen schnell und sicher, es gibt eigentlich nur vorteile. Ich versuche mich akribisch genau daran zu halten.

 

[Wolfsbein]

Hmmm ich halte mich eher an die Hungary Konventionen. Aber das ist natürlich Ansichtssache. Was ich fürchterlich finde ist dass kein Tab erlaubt ist, sondern nur vier Leerzeichen. Wenn man z.B. mit Vim arbeitet ist das kein Problem, aber es gibt genügend Programme, die einn Tab nicht automatisch umwandeln .

 

[Create]

Docs scheinen sinnvoll!

Hallo,
Auch die PHPDocs sind "nur eine" Konvention (<irgendwie wiederspricht sich das doch?). Letztenendes ist keiner gezwungen irgendwas einzuhalten (vielleicht nur der Arbeitgeber die Regeln können selbst festgelegt werden aber die Vorteile einer Konvention liegen auf der Hand

- Lesbarer
- Schnellere Einarbeitung etc.

Die PHPDocs sind schon sinnvoll und mit den @-Tags können sie sehr übersichtlich komplexere Zusammenhänge darstellen. Allerdings sind viele Tags noch in der Erprobung und teilweise nur per Aussage vorhanden nicht aber schon im Einsatz.

Greetz
CrAte