Php annotation_php tutorial

Php Annotation specification. @ Access usage scope: class, function, var, define, and module. this tag is used to specify the access permission for the keyword: private, public, or proteced @ author. specify the author @ copyright usage range: c @ access.

Usage scope: class, function, var, define, module

Indicates the access permission for a keyword: private, public, or proteced.

@ Author

Specify author

@ Copyright

Usage scope: class, function, var, define, module, use

Copyright information

@ Deprecated

Usage scope: class, function, var, define, module, constent, global, include

Specify unnecessary or obsolete keywords

@ Example

This tag is used to parse the content of a file and highlight it. Phpdoc will try to read the file content from the file path marked

@ Const

Scope of use: define

Used to specify the define constant in php

@ Final

Usage scope: class, function, var

Specifies that a keyword is a final class, method, or attribute, and cannot be derived or modified.

@ Filesource

Similar to example, however, this tag will directly read and display the content of the currently resolved php file.

@ Global

Specifies the global variables referenced in this function.

@ Ingore

Used to ignore specified keywords in the document

@ License

It is equivalent to the URL in the html tag, followed by the content to be displayed.

Such as http://www.baidu.com "> Baidu

Can Write @ license http://www.baidu.com Baidu

@ Link

Similar to license

However, you can refer to any keyword in the document through link.

@ Name

Specify an alias for the keyword.

@ Package

Scope of use: page-> define, function, include

Class-> class, var, methods

It is used to logically group one or more keywords into one group.

@ Shortcut

Indicates that the current class is an abstract class.

@ Param

Specify the parameters of a function.

@ Return

Specifies the return value of a method or function.

@ Static

Indicates that the word is static.

@ Var

Variable type

@ Version

Specify version information

@ Todo

Specify the areas to be improved or not implemented

@ Throws

Indicates the error exception that this function may throw.

As mentioned above, the mark of common documents must start with @ at the beginning of each line. In addition, there is also a mark called inline tag, which is represented by {@}, including the following:

{@ Link}

Usage: @ link

{@ Source}

Display the content of a function or method

Http://www.bkjia.com/PHPjc/371748.htmlwww.bkjia.comtruehttp://www.bkjia.com/PHPjc/371748.htmlTechArticle@access scope of use: class, function, var, define, module this tag is used to specify the access permission for the keyword: private, public or proteced @ author specifies the author @ copyright scope of use: c...