php how to regulate class notes

@access
range: class, function, var, define , module
mark is used for access to specified keywords: private, public or proteced
@author
specified OF
@copyright
range: class, function, var, define , module, use
the copyrighted information
@deprecated
range: class, function, var, define , module, constent, global, include
specified or not obsolete keywords
@example
the mark period for parsing the file content, and they highlight. Phpdoc will attempt to read a file from the file path of the tag to the
@const
range: define
used to specify the constants that define PHP
@final
range: class, function, var
specified keyword is a final class, method, property, prohibition of variants, modifications.
@filesource
and example similar, but the tag will directly read the contents of php file being parsed and displayed.
@global
global variables specified referenced in this function
@ingore
in a document ignores the specified keyword
@license
Equivalent <a> html tag, first URL, followed by the contents to be displayed
such as <a href=" http://www.baidu.com "> Baidu </a>
can be written @license  HTTP: // www.baidu.com  Baidu
@link
similar license
but can also mean a key link to any document
@name
specify an alias for the keyword.
@package
range: page level -> define, function, include
the class level -> class, var, methods
for one or more keywords to logically grouped together.
@abstrcut
Description of the current class is an abstract class
@param
indicates a function parameter
@return
indicates a method or function return means
@static
specified by Key word is static.
@var
specified variable type
@version
indicates the version information
@todo
indicated should be improved or where there is no realization of
@throws
specified circumstances this function may throw an error exception occurs extremely
Mentioned above, Common document tag must be at the beginning of each line to the @ sign, in addition, there is a flag called the inline tag, denoted by {@}, specifically including the following:
{} @link
Usage with @link
{} @ Source
display contents of a piece of function or method

Guess you like

Origin www.cnblogs.com/ysbl/p/11946365.html