[php]Dokumentation

D

Darklord

XHTML|PHP|SQL|C
ID: 227795
L
19 September 2006
981
73
Hallo,

Ich wollte mal fragen wie Ihr euren PHP Code Dokumentiert, sprich in Form von UML/Datenbankdesign/Kommentare. Dokumentiert Ihr überhaupt? Ich finde zumidest bei größeren Projekten ein muss.
Gibt es nützliche Programme die einen die etwas lästige Handarbeit ersparen?
Bin gespant auf Eure Antworten. ;)

Gruß
 
Bei uns wird streng auf saubere Kommentare für eine spätere
(automatisierte) Dokumentation geachtet.

Die passenden Programme bzw. Skripte gibt es für viele Sprachen,
z.B. Javadoc oder PhpDocumentor.
Und selbst für Stylesheets wird schon an Cssdoc gearbeitet.
 
Ja, hierfür bietet sich am besten phpDocumentor (https://www.phpdoc.org/) ^^

Ich persönlich Dokumentiere meinen Code anhand dieser Tags und lasse dann am Ende phpDocumentor via Zend durchlaufen.

Und in Sachen UML mache ich nur bei größeren Projekten. Der Aufwand lohnt sich persönlich für mich nicht, wenn man nur eine Ein- bzw. Ausgabe hat ^^ Das selbe gilt beim Datenbankdesign. Wenn es mehr wie 2 Tabellen in relation sind, benutze ich auch dort ein Programm (DB Designer; https://www.fabforce.net/dbdesigner4/)
 
PHPDoc zum dokuentieren von Klassen, Methoden, Attributen etc und dann im Code noch so all 4-5 Zeilen nen Comment um auch Codeabschnitte nochmal zu erklären.
UML nur gaaaaanz selten, lohnt sich nur bei wenigen Projekten.
MySQL-Datenbanken und deren Beziehungen werden mit der MySQL Workbench (Nachfolger des Fabforce DB-Designers) erstellt.
 
ice-breaker schrieb:
PHPDoc zum dokuentieren von Klassen, Methoden, Attributen etc und dann im Code noch so all 4-5 Zeilen nen Comment um auch Codeabschnitte nochmal zu erklären.
UML nur gaaaaanz selten, lohnt sich nur bei wenigen Projekten.
MySQL-Datenbanken und deren Beziehungen werden mit der MySQL Workbench (Nachfolger des Fabforce DB-Designers) erstellt.
Zum Vergrößern anklicken....

Das von MySQL Workbench wusste ich noch garnicht; Danke x) Werde ich gleich mal ausprobieren >:
 
Du musst dich einloggen oder registrieren, um hier zu antworten.
Zurück
Oben