|
@global
Mit Hilfe von @global wird darauf hingewiesen, daß eine Funktion
eine globale Variable benutzt.
|
Syntax und Scope
|
|
Syntax
|
@global (object objectname|type) $varname [description]
|
|
Scope
|
function
|
Für jede globale Variable die verwendet wird, ist ein @global Tag
im Doc Comment zu plazieren.
PHPDoc ist nicht in der Lage, die korrekte Verwendung
des Tags zu überprüfen. Es ist unwahrscheinlich, das
kommende Versionen in naher Zukunft einen Vergleich von Dokumentation
und Programmtext bieten werden.
|
Codebeispiel
|
/**
* Simuliert include_once in PHP 3.
*
* @global array $__used_files Liste bereits eingebundener Files
* @access public
*/
function include_once($filename) {
global $__used_files;
if (!isset($__used_files["include_once"][$filename])) {
$__used_files["include_once"][$filename] = true;
include($filename);
}
}
|
|
Generierte Dokumentation
|
Public Method Details |
include_once |
|
public void include_once( $filename )
|
| |
Simuliert include_once in PHP 3.
|
| Parameter |
|
|
| Returns |
void |
| Required global variables |
|
| array $__used_files |
Liste bereits eingebundener Files |
|
|
|
|
