Kommentarblock für den PHP-Programmheader
Jeder Programmkopf muss einen einheitlichen Kommentarblock haben. Die Regeln lauten wie folgt:
a. Muss eine Beschreibung des Programms enthalten;
b. Muss den Autor enthalten
c. Muss das Datum des Schreibens enthalten;
d. Versionsinformationen müssen enthalten sein;
e. Muss den Projektnamen enthalten;
f. Muss den Namen der Datei enthalten;
g. Wichtige Nutzungsanweisungen, wie Klassenaufrufmethoden, Vorsichtsmaßnahmen usw.;
Referenzbeispiele sind wie folgt:
<?php // // +---------------------------------------------------------+ // | PHP version 4.0 | // +---------------------------------------------------------+ // | Copyright (c) 1997-2001 The PHP Group | // +---------------------------------------------------------+ // | This source file is subject to of the PHP license, | // | that is bundled with this packafile LICENSE, and is | // | available at through the world-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the and are unable to | // | obtain it through the world-wide-web,end a note to | // | license@php.net so we can mail you a immediately. | // +---------------------------------------------------------+ // | Authors: Stig Bakken <ssb@fast.no> | // | Tomas V.V.Cox <cox@idecnet.com> | // | | // +---------------------------------------------------------+ // // $Id: Common.php,v 1.8.2.3 2001/11/13 01:26:48 ssb Exp $
