|
@parameter
Die Parameter einer Funktion werden mittels @parameter beschrieben.
|
Syntax und Scope
|
|
Syntax
|
@param[eter] (object objecttype|type) [$varname] [description]
|
|
Scope
|
function
|
Parameter mit Defaultwerten werden von PHPDoc erkannt. Der vorbelegte
Wert wird in die Dokumentation aufgenommen. Fehlt eine Typangabe, versucht
PHPDoc den Typ zu raten. Scheint gerade broken ;( ...
Funktionsköpfe werden mit der dokumentierten Parameterliste verglichen.
Bei Unstimmigkeiten generiert PHPDoc eine Warnung im Report.
|
Generierte Dokumentation
|
|
|
Private Method Details |
render |
|
private boolean render( string $format, string $target, [ string $tplroot ] )
|
| |
Erste Zeile: Kurzbeschreibung für Übersichten.
Mehrzeiliger, optionaler Dokumentationsblock.
Reihenfolge: Übersichtssatz - Kommentar - Tags.
|
| Parameter |
|
| string |
$format |
|
|
Ausgabeformat. Derzeit kennt PHPDoc nur "html". Spätere
Versionen werden mehr bieten. Angedacht sind PDF und DocBook. |
|
|
| string |
$target |
|
|
Verzeichnis in dem die Dokumentation gespeichert werden soll. |
|
|
| string |
$tplroot |
= >>""<< |
|
Verzeichnis, das die Templates enthält.
Fallback auf $this->templateRoot |
|
| Returns |
boolean False bei Problemen, ansonsten true. |
| See Also |
parse(), setTemplateRoot(), $templateRoot |
|
|
|
|
Codebeispiel
|
class Parameter {
/**
* Funktion mit Defaultparametern verschiedener Typen.
*
* Alle Parameter sind undokumentiert. PHPDoc wird den Typ
* raten. Meist gelingt dies zufriedenstellend.
*
* @access public
*/
function guessType($string = "string", $float = 3.14, $floatExp = 1.2e18, $int = 4, $hex = 0xfafa, $oct = 0711, $bool = false, $array = array() ) {
}
/**
* Funktion mit einem optionalen Parameter.
*
* @param string
* @access public
*/
function defaultValue($string = "string") {
}
}
|
|
Generierte Dokumentation
|
|
|
|
