|
@constant
Mit @constant werden durch define() deklarierte Konstanten beschrieben.
|
Syntax und Scope
|
|
Syntax
|
@const[ant] label [description]
|
|
Scope
|
define
|
Die Semantik der Beschreibung, die dem Tag folgt, ist nicht definiert.
Der Anwender wird gebeten, eine eigene Definition vorzunehmen.
Der Tag muß im Doc Comment enthalten sein. Fehlt @const[ant], erzeugt PHPDoc
eine Warnung. Der Zwang dient der Wahrung einer aktuellen, dem Code entsprechenden
Dokumentation. Wird der Name und damit möglicherweise die Bedeutung
einer Konstanten verändert, so muß auch die Dokumentation überarbeitet werden.
|
Codebeispiel
|
/**
* Höchstwert gleichzeitig erlaubter Clients.
* @const MAX_CLIENTS maximale Clientzahl
*/
define("MAX_CLIENTS", 1000, true);
/**
* Höchstwert der Anfragen pro Client.
* @const MAX_REQUESTS_PER_CLIENT
*/
define("MAX_REQUESTS_PER_CLIENT", 5);
|
|
Generierte Dokumentation
|
|
|
Private Constant Details |
MAX_CLIENTS
define( MAX_CLIENTS, >>1000<< )
Case: case insensitive, userdefined: 'true'
|
|
MAX_REQUESTS_PER_CLIENT
define( MAX_REQUESTS_PER_CLIENT, >>5<< )
Case: default: case sensitive
|
|
|
|
|
