PHP Programming Language - Cultural View

PHPDoc 178
Now, the page has its documentation, and the define has its own documentation.
So, a DocBlock is a page-level DocBlock IF AND ONLY IF it is both:
1. The first DocBlock in a file
2. Either:
1. Contains a @package tag, or
2. Is immediately followed by another DocBlock for any documentable PHP element (this is deprecated, always
use a @package tag)
A Page-level DocBlock may have any of the standard phpDocumentor Tags (see Standard phpDocumentor Tags)
plus the following tags:
• @package
• @subpackage
phpDocumentor will not document a file like the first example, there must be at least one documentable PHP
element in the file.
Tags
Tags are single words prefixed by a "@" symbol. Tags inform parsers how to present information and modify
display of documentation as well as allow the IDE to define variable types. All tags are optional, but if you use a tag,
they do have specific requirements to parse properly.
Common tags
Tag Usage Description
@abstract Documents an abstract class, class variable or method.
@access public, private or protected Documents access control for an element. @access private indicates that documentation of element be
@author author name
prevented.
Documents the author of the current element.
@copyright name date Documents copyright information.
@deprecated version Documents a method as deprecated.
@deprec same as @deprecated
@example /path/to/example Documents the location of an external saved example file.
@exception documents an exception thrown by a method — also see @throws.
@global type $globalvarname Documents a global variable or its use in a function or method.
@ignore Prevents the documentation of an element
@internal private information for advanced developers
@link URL
@name global variable name Specifies an alias for a variable. For example, $GLOBALS['myvariable'] becomes $myvariable
@magic phpdoc.de compatibility "phpDocumentor tags" [1] .
@package name of a package Documents a group of related classes and functions.
@param type [$varname] description
@return type description This tag should not be used for constructors or methods defined with a void return type.
@see Documents an association to another method or class.
@since version Documents when a method was added to a class.