M.: Problem mit Auswertung von $_POST

Beitrag lesen

Mahlzeit,

Jede Variable zu dokumentieren ist einfach Unsinn, dann kann ich auch direkt den Quelltext lesen.

Dazu müsste der Dokumentator (schreibt man den so?) aber zumindest ansatzweise was vom Programmieren verstehen.

Eine gute Dokumentation behandelt verwendete Muster und logisch geschichte Schnittstellen-Dokumentation. Eine zeilenweise oder ausdrucksweise Dokumentation bietet gegenüber dem reinen Quelltext kaum einen Mehrwert, es macht nur unnötige Arbeit die Dokumentation mit dem Quelltext synchron zu halten.

Der Mehrwert ist, dass die Laien in der Chefetage glauben zu verstehen, was die Software macht.

Um die Code-Qualität zu garantieren sind zudem Modul-Tests ein häufig verwendetes Werkzeug.

Die macht dann ein weiteres Team, das einige hundert km weg arbeitet, in einer anderen Server-Infrastruktur sitzt, andere Entwicklungsumgebungen hat und mit der Doku nix anfangen kann, weil sie ein Laie geschrieben hat.

--
eigentlich ist mir bewusst, dass ich hin und wieder einfach mal die Klappe halten sollte. Doch genau in den unpassendsten Momenten erwische ich mich dabei, wie ich dennoch etwas sage ...