PHP-Dokumentation

Zum Dokumentieren von PHP-Scripts empfiehlt sich die Software phpDocumentor.

Hier ein paar wichtige Tags:

@abstract, @final, @static - Klassen- oder Methodendokumentation als abstrakt, final oder statisch

@access - @access private protected public {public|protected|private} - Sichtbarkeit des dokumentierten Codeelementes

@author - @author authorname - Informationen zum Autor

@copyright - @copyright copyright information (Copyright © 2006) - Informationen zum Copyright

@deprecated - @deprecated version/info string (veraltet (opt. seit Version 2.0)) - Codeelement wird als ausgemustert markiert

@ignore - @ignore (ignoriert (z.B. bei doppelten Konstanten in if/else)) - ignoriert das Codeelement

@internal - @internal any information that should not be displayed in public documentation [unspecified format] (intern (Firmenstruktur), intern (bei Classes)) - Codeelement wird nicht in Dokumentation aufgenommen

@link - URL link text UND/ODER @link URL, URL, URL... (URL (mehrere URL, URL, URL / Name URL name))

@see - @see file.ext|elementname|class::methodname()|class::$variablename|functionname()|function functionname unlimited number of values separated by commas - Verweis auf die Dokumentation eines anderen Codelementes

@since - @since version/info string [unspecified format] - seit welcher Version das Codeelement existiert

@version - @version versionstring [unspecified format] - Informationen zur Version

Hunger???

www.schlecker.de