PEAR Handbuch | ||
---|---|---|
Zurück | Kapitel 4. PEAR Codierstandards | Nach vorne |
Inline-Dokumentation für Klassen sollten entsprechend der PHPDoc Konvention erfolgen (ähnlich Javadoc). Mehr Information über PHPDoc finden Sie hier: http://www.phpdoc.de/
Weitere Kommentare, welche nicht der Klassendokumentation dienen, werden nachdrücklich empfohlen. Eine generelle Faustregel ist: Wenn Sie auf ein Stück Code blicken und denken "Wow, ich möchte das nicht versuchen und beschreiben", dass Sie es auf jeden Fall kommentieren sollten, bevor Sie vergessen, wie es funktioniert.
Verwenden Sie Kommentare im Stil von C (/* */) und C++ (//) und vermeiden Sie Kommentare im Stile von perl/shell (#) zu vermeiden sind.
Zurück | Zum Anfang | Nach vorne |
Funktionsdefinitionen | Nach oben | Einfügen von Code |