Home  >  Article  >  Backend Development  >  Comment specifications, code comment specifications_PHP tutorial

Comment specifications, code comment specifications_PHP tutorial

WBOY
WBOYOriginal
2016-07-12 08:56:551120browse

Comment specifications, code comment specifications

@access
Usage scope: class, function, var, define, module
This tag is used to indicate the access permissions 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
Indicates unused or obsolete keywords
@example
This tag is used to parse a piece of file content and add them to the highlighted. Phpdoc will try to read the file content from the file path given by this tag
@const
Using scope: define
Used to specify the constant defined in php
@final
Using scope: class ,function,var
indicates that the keyword is a final class, method, or attribute, and is prohibited from being derived or modified.
@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
is used to ignore the specified keyword in the document
@license
is equivalent to < in the html tag ;a>, first the URL, then the content to be displayed
For example, Baidu
can be written @license http ://www.baidu.com Baidu
@link
is similar to license
but you can also point to any keyword in the document through link
@name
to specify a keyword Alias.
@package
Usage scope: page level -> define, function, include
Class level ->class, var, methods
is used to logically combine one or several keywords Assigned to a group.
@abstrcut
Indicates that the current class is an abstract class
@param
Indicates the parameters of a function
@return
Indicates the return pointer of a method or function
@static
Indicates that the Guan Jianzi is static.
@var
Indicate the variable type
@version
Indicate the version information
@todo
Indicate the areas that should be improved or not implemented
@throws
Indicate that this function may Error exceptions thrown, extremely rare
As mentioned above, ordinary document tags must be marked with @ at the beginning of each line. In addition, there is also a tag called inline tag, using {@} Expressions include the following types:
{@link}
Usage is the same as @link
{@source}
Display the content of a function or method

www.bkjia.comtruehttp: //www.bkjia.com/PHPjc/1110530.htmlTechArticleComment specification, code comment specification @access Scope of use: class, function, var, define, module This tag is used Specify the access permission of the keyword: private, public or protected @author Specify the author...
Statement:
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn