Sa

16

Feb

2013

Programmier-Konventionen: Kommentare

Regel: Es werden überall dort Kommentare angefügt, wo der Ablauf für einen anderen Programmierer nicht auf Anhieb nachvollziehbar ist.

Erlaubte Kommentarvarianten
Einzeilige Kommentare:
// Dies ist ein Kommentar
mehrzeilige Kommentarblöcke:
/**
 * Description
 * Kommentar
 */

Dateien
Am Anfang einer Datei muss immer ein Kommentarblock stehen.
Beispiel:
/**
 * filename.php
 *
 * Beschreibung, was in dieser Datei gemacht wird,
 * von wo sie aufgerufen wird etc.
 *
 * part of: (Projektname)
 * copyright: (Name des Coders, Name der Firma)
 * web: http://tssh.jimdo.com
 * coder: (Name des Coders)
 * date: Jul 09
 * version: 2.1
 */

Kommentar schreiben

Kommentare: 0