PHP Coding Standard

Logo: PHP
8. Regel 5: Jede Datei wird mit Änderungskommentaren und einem Zeitstempel versehen

Wenn kein SVN oder CVS zur Verfügung steht, sollte das Team eine Konvention vereinbaren, wie es Änderungen am Source-Code dokumentiert. Zum Beispiel könnte man die Initialen jedes Teammitglieds verwenden plus das Datum nach dem ISO 8601 Standard.

PHP
   // CVB 2006-05-23: Refactoring
   while ($row = mysql_fetch_assoc($result))
   (...)

Dasselbe gilt natürlich auch für HTML-Dateien.

HTML
   <!-- CVB 2006-05-23: Refactoring -->
   <table border="2">
   (...)

Es wird empfohlen fünf dieser Kommentare aufzubewahren, damit die letzten (Arbeits)Schritte nachvollzogen werden können. Ob die Kommentare im Kopf der Datei gemacht werden oder an der Stelle, wo die Änderungen gemacht werden, sollte das Team vor dem Projekt entscheiden und dann einheitlich für alle Dateien umsetzen.

Ausnahme zu Regel 5: Es steht ein SVN oder CVS zur Verfügung. In diesem Fall sollte Gebrauch von den Funktionen dieser Software gemacht werden.