|
@author
@author erlaubt die Nennung von Autoren.
|
Syntax und Scope
|
|
Syntax
|
@author Name [<email>] [, ...]
@author darf mehrmals in einem Doc-Comment verwendet werden.
|
|
Scope
|
class, function, var, define, module, use
|
Zu jedem Autor kann eine Kontakadresse in Form einer E-Mail angegeben werden.
Jede E-Mail wird in der HTML Dokumentation als "mailto:"-Link dargestellt.
Die Autorenangabe impliziert keine Aussage über das Copyright.
Ein Copyrightvermerk wird mit dem Tag @copyright
notiert.
|
Codebeispiel
|
/**
* Oberklasse der geometrischen Figuren
* @abstract
* @access public
* @author Ulf Wendel <ulf.wendel@phpdoc.de>
* @author Ulf Wendel <uw@netuse.de>
*/
class geomfigure {
/**
* Skalierungsfaktor bei der Darstellung.
* @abstract
*/
var $skale;
/**
* Zeichnet das Objekt.
* @abstract
* @access public
*/
function paint() {
;
}
}
|
|
Generierte Dokumentation
|
File: c:/www/apache/doc2//bla/author.php
PHPDoc -
geomfigure
geomfigure
Oberklasse der geometrischen Figuren
|
public abstract class geomfigure
Oberklasse der geometrischen Figuren
|
|
|
