|
@see
Verweise innerhalb der API Dokumentation werden durch @see beschrieben.
|
Syntax und Scope
|
|
Syntax
|
@see (function()|$varname|((module|class)::)(function()|$varname)) [, ...]
|
|
Scope
|
class, function, var, module, define, use
|
PHPDoc ist in der Lage, Verweise sowohl Verweise innerhalb einer Klasse bzw. eines Moduls als
auch über Klassen- und Modulgrenzen hinweg darzustellen.
Verweise über Klassen- und Modulgrenzen hinweg, haben die Form: (module|class)::(function()|$varname).
Es wird keine Überprüfung der Gültigkeit eines Verweises vorgenommen.
|
Codebeispiel
|
class seedemo {
/**
* Zeitpunkt der Erzeugung des Objekts.
*
* @var string
* @see seedemo()
*/
var $creationTime = "";
/**
* Speichert den Zeitpunt der Erzeugung des Objekts.
*
* @see $creationTime
*/
function seedemo() {
$this->creationTime = microtime();
}
/**
* Zeigt den Zeitpunkt der Instantzierung des Objekts an.
*
* @see $creationTime, seedemo(), time::microtime()
*/
function printCreationTime() {
print "{$this->creationTime} <br>";
}
}
|
|
Generierte Dokumentation
|
Public Method Details |
seedemo |
|
public void seedemo( )
|
| |
Speichert den Zeitpunt der Erzeugung des Objekts.
|
| Returns |
void |
| See Also |
$creationTime |
|
|
|
|
|
|
|
|
