phpbar.de logo

Mailinglisten-Archive

[php] Kurze Frage zu PHPDocumentor

[php] Kurze Frage zu PHPDocumentor

Sebastian Mendel lists at sebastianmendel.de
Mit Okt 25 09:02:31 CEST 2006


Ralf Eggert schrieb:
> Namt Liste,
> 
> irgendwo habe einmal gelesen, dass man beim PHPDocumentor eine Liste von
> require_once() Aufrufen mit einem einzigen Kommentar dokumentieren kann.
> Leider finde ich die Stelle nicht mehr, wo ich das gelesen habe.

das gilt nicht nur für includes sondern für alles was Dokumentierbar ist
 mit phpDocumentor, z. B. Eiegnschaften, Konstanten, Globals, ... usw.


> Bei diesem Beispiel wird in der erstellen API Doku dann nur das erste
> require_once mit dem Kommentar versehen.
> 
>   /**
>    * require Simpletest files
>    */
>   require_once('simpletest/web_tester.php');
>   require_once('simpletest/reporter.php');
> 
> Hat jemand eine Tipp für mich?

/**#@+
 *
 */
...
/**#@-*/

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.docblocktemplate

-- 
Sebastian Mendel

www.sebastianmendel.de

php::bar PHP Wiki   -   Listenarchive