|
Doc Comments
PHPdoc Doc Comments haben eine vorgegebene äußere Form. Sie können
Dokumentationstags enthalten und stehen vor bestimmten Keywords.
|
Beispiel eines Doc Comments
|
/**
* Erste Zeile: Kurzbeschreibung für Übersichten.
*
* Mehrzeiliger, optionaler Dokumentationsblock.
* Reihenfolge: Übersichtssatz - Kommentar - Tags.
*
* @param string Ausgabeformat. Derzeit kennt PHPDoc nur "html". Spätere
* Versionen werden mehr bieten. Angedacht sind PDF und DocBook.
* @param string Verzeichnis in dem die Dokumentation gespeichert werden soll.
* @param string Verzeichnis, das die Templates enthält.
* Fallback auf $this->templateRoot
* @return boolean False bei Problemen, ansonsten true.
* @see parse(), $templateRoot, setTemplateRoot()
*/
function render($format, $target, $tplroot="") { ... }
|
|
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 |
|
|
|
