11.3. DocBlock Tags
Die DocBlock Tags werden grundsätzlich mit einem @ eingeleitet. Die Tags sind alle optional, wenn sie verwendet werden, muss man sich an die Regeln halten, um ein korrektes Parsen zu ermöglichen.
|
Schlüsselwort |
Bedeutung |
|---|---|
|
@access |
Das access Tag kann die Werte public und private haben. Mit @access private dokuemtnierte Elemente werden bei phpDocumentor nur ausgegeben, wenn die Kommandozeilenoption -parseprivate gesetzt ist. |
|
@author |
Autor des Codeabschnitts |
|
@version |
Version des Codeabschnitts |
|
@copyright |
Name und Datum. |
|
@link |
eine weiterführende URL |
|
@param |
Parameter (Wert und Typ, ggf. auch Angabe von optional) der Funktion bzw. Methode in der Reihenfolge der An- bzw. Übergabe. Das param-Tag hat die Form @param datentyp $parametername Beschreibung . |
|
@return |
Typ des Rückgabewerts der Funktion bzw. Methode |
|
@see |
Innerhalb der Dokumentation zu verlinkendes, ebenfalls dokumentierbares Element |
Beispiel 11.3. Doc Block für Funktion
/**
* This Methods allows you to set the Cache Directory
*
* @access public
* @author r23 <info@r23.de>
* @param string $dir Path to Directory.
* @return boolean
* @see _cache_dir
*/
function set_CacheDir( $dir )
{
if(substr($dir, -1) != "/") {
$dir = $dir."/";
}
$this->_cache_dir = $dir;
}
