Sie müssen vollständige Inline-Dokumentation
bereitstellen (Docblocks). Lesen Sie
hierzu auch die Abschnitte
Beispieldatei und
Kopf-Kommentare
dieses Kapitels, um mehr über das Format der Docblocks
für PEAR-Packages zu erfahren.
Weitere Informationen erhalten Sie auch über die Webseite von
phpDocumentor.
Sie sollten auch abseits der offziellen API-Dokumentation Kommentare
im Quellcode einsetzen. Als Daumenregel gilt, wenn Sie auf
einen Code-Abschnitt schauen und denken:
„Wow, Ich würde nicht versuchen herauszufinden, wie es funktioniert“,
sollten Sie auf jeden Fall einen Kommentar ergänzen, bevor
Sie vergessen, wie es funktioniert.
Kommentare im C-Stil (/* */) und von Standard-C++ (//)
sollten verwendet werden. Kommentare im Perl/shell-Stil (#)
sollten Sie vermeiden.
