|
@link
Mittels @link können Verweise auf Internetadressen angelegt werden.
|
Syntax und Scope
|
|
Syntax
|
@link URL [description]
|
|
Scope
|
class, function, var, module, define, use
|
Es ist nicht sinnvoll, Ausführungen zum verwendeten Algorithmus
in die API Dokumentation aufzunehmen, da diese für den Benutzer
ohne Bedeutung sind. Stattdessen sollte auf eine externe Quelle,
z.B. eine Internetadresse, verwiesenwerden.
Zukünftige Versionen von PHPDoc werden einen Tag zur Einbindung
von lokalen Dateien bieten. Der Tag wird sich selbst durch
den Inhalt der referenzierten Datei ersetzen. Er ist vergleichbar
mit der PHP Funktion include(). Der Name des Tags
ist noch offen.
|
Codebeispiel
|
/**
* Klasse zur Kompression von Daten nach Huffman.
*
* @access public
*/
class huffman_compression {
/**
* Codiert die an die Klasse übergebenen Daten.
*
* @link http://www.compressconsult.com/huffman/ Hinweise zum Algorithmus.
* @access public
*/
function encode() {
...
}
}
|
|
Generierte Dokumentation
|
|
|
|
