PHP file Annotation mark and Specification summary _php Foundation

PHP annotation Tag





@access


Use range: Class,function,var,define,module


This tag is used to indicate access rights for a keyword: private, public, or proteced





@author


indicates the author





@copyright


Use range: Class,function,var,define,module,use


Specify copyright Information





@deprecated


Use range: Class,function,var,define,module,constent,global,include


indicate unused or deprecated keywords





@example


the tag to parse a piece of file content and highlight them. Phpdoc will attempt to read the contents of the file from the file path that is marked





@const


Use range: Define


is used to indicate define constants in PHP





@final


Use range: Class,function,var


indicates that the keyword is a final class, method, property, and prohibits derivation and modification.





@filesource


and example are similar, except that the tag will directly read the contents of the currently parsed PHP file and display it.





@global


indicates the global variable referenced in this function





@ingore


is used to ignore the specified keyword in the document





@license

The
corresponds to the <a&gt in the HTML tag, first the URL, and then the content to be displayed


such as <a href= "http://www.baidu.com" > Baidu </a>


can write @license http://www.baidu.com Baidu





@link


similar to license


But you can also refer to any one of the keywords in the document through link





@name


specifies an alias for the keyword.





@package


Usage: page-level-> define,function,include


class-Level->class,var,methods


is used to logically divide one or several keywords into one group.





@abstrcut


indicates that the current class is an abstract class





@param


indicates the parameters of a function





@return


indicates the return point of a method or function





@static


indicates that the closed word is static.





@var


indicates the variable type





@version


indicates version information





@todo


indicate where it should be improved or not implemented





@throws


indicates a possible error exception that may be thrown by this function, which occurs extremely





Ordinary document tag tags must be at the beginning of each line at the @ mark, in addition, there is a tag called inline tag, expressed in {@}, specifically include the following:





{@link}


usage with @link





{@source}


Displays the contents of a function or method





Annotation Specification

A. Note must be





/**


* Annotation Content


*/




The form of






B. For functions that reference global variables, you must use the glboal tag.





c. For a variable, you must mark its type with VAR (int,string,bool ...). ）





d. Functions must indicate their parameters and return values through the Param and returned tags





E. For the occurrence of two or more than two keywords, to be ignored by the ingore redundant, only one can





F. Where other functions or classes are invoked, link or other tags are linked to the appropriate section to facilitate the reading of documents.





G. Use of non-document annotations, where necessary, to improve the readability of the code.





H. Descriptive content as concise as possible, using phrases rather than sentences.





I. Global variables, static variables and constants must be indicated with the corresponding markup