Summary of PHP file comment marks and specifications_PHP tutorial

PHP comment tag

@access
Usage scope: class, function, var, define, module
This tag is used to indicate the access rights of keywords: private, public Or protected

@author
Indicate the author

@copyright
Usage scope: class, function, var, define, module, use
Indicate copyright information

@deprecated
Usage scope: class, function, var, define, module, constent, global, include
Indicate unused or obsolete keywords

@example
This tag is used Parse the contents of a file and highlight them. Phpdoc will try to read the file content from the file path given by this tag

@const
Usage scope: define
is used to specify the constant defined in php

@final
Usage scope: class, function, var
Indicates that the keyword is a final class, method, attribute, and prohibits derivation and modification.

@filesource
is similar to example, except that this tag will directly read the content of the currently parsed php file and display it.

@global
Indicates the global variable referenced in this function

@ingore
Used to ignore the specified keyword in the document

@license
Equivalent to in the html tag, first the URL, then the content to be displayed
For example BaiduCan be written as @license http://www.baidu.com Baidu

@link
Similar to license
But you can also point to any keyword in the document through link

@name
Specifies an alias for the keyword.

@package
Usage scope: page level -> define, function, include
Class level ->class, var, methods
is used to logically combine one or more keywords are grouped together.

@abstrcut
Indicates that the current class is an abstract class

@param
Specifies the parameters of a function

@return
Specifies a method or function The return pointer is

@static
indicating that the keyword is static.

@var
Indicate the variable type

@version
Indicate the version information

@todo
Indicate what should be improved or not implemented

@throws
Indicates the error exceptions that this function may throw, and the extreme situations

Ordinary document markup tags must be marked with @ at the beginning of each line. In addition, there is This kind of tag is called inline tag, represented by {@}, which includes the following types:

{@link}
Usage is the same as @link

{@source}
Display a paragraph Contents of functions or methods

Annotation specification

a. The annotation must be

/**
* Annotation content
*/

The form is

b. For functions that reference global variables, the glboal tag must be used.

c. For variables, their types must be marked with var (int, string, bool...)

d. Functions must indicate their parameters and return values ​​through param and return tags

e. For keywords that appear twice or more, ignore the redundant ones through ingore and keep only one

f. Where other functions or classes are called, use link or Other tags link to corresponding sections to make the document easier to read.

g. Use non-documentation comments where necessary to improve code readability.

h. Keep descriptive content concise and to the point, using phrases rather than sentences whenever possible.

i. Global variables, static variables and constants must be declared with corresponding tags