dedlfix: erstes echt großes Projekt

Beitrag lesen

echo $begrüßung;

Nö, ich hab schon Dokumentation gemeint!
(Soll etwas ausführlicher als nur eine Zusammenfassung der Klassenbeschreibungen sein)
V.a. da vermutlich alle zwei Monate neue Module hinzukommen werden...

Eine vollständige funktionsbeschreibende Dokumentation für Programmierer fände ich mit phpdoc-Syntax im Code notiert (und gegebenenfalls mit Tools daraus extrahiert) am sinnvollsten. Man hat damit alle Quellen an einem Fleck und die Gefahr, die Dokumentation anzupassen zu vergessen ist geringer, weil einem beim Ändern der Code-Datei die Dokumentationskommentare ins Auge fallen.

Eine (zusätzliche) Anleitung im Tutorial-Stil hingegen ist sicher in einem Extra-Dokument besser aufgehoben. Man muss da ja vielleicht nicht jedes Detail des Codes und jeden Parameter einer Funktion beschreiben und man hat auch andere Möglichkeiten, die Ausgabe zu formatieren.

Ebenso finde ich es sinnvoll, eine Bedienungsanleitung für den Anwender in einem eigenständigen Dokument unterzubringen.

echo "$verabschiedung $name";