Home  >  Article  >  Backend Development  >  PHP comment specifications_PHP tutorial

PHP comment specifications_PHP tutorial

WBOY
WBOYOriginal
2016-07-21 14:51:51846browse

 @access

Scope of use: class, function, var, define, module

This tag is used to indicate the access permission of the keyword: private, public or protected

 @author

Specify the author

 @copyright

Scope of use: class, function, var, define, module, use

Specify copyright information

 @deprecated

Scope of use: class, function, var, define, module, constent, global, include

Specify unused or obsolete keywords

@example

This tag is used to parse a piece of file content and highlight them. Phpdoc will try to read the file content from the file path given by this tag

@const

Scope of use: define

Used to specify the constants defined in php

@final

Usage scope: class, function, var

Specifies that the keyword is a final class, method, or attribute, and is prohibited from being derived or modified.

 @filesource

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

 @global

Specify the global variable referenced in this function

 @ingore

Used to ignore specified keywords in the document

 @license

Equivalent to in the html tag, first is the URL, then the content to be displayed

For example Baidu

Can 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

Specify an alias for the keyword.

 @package

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

Class level -> class, var, methods

Used to logically group one or several keywords into a group.

 @abstrcut

Indicates that the current class is an abstract class

@param

Specify the parameters of a function

@return

Specifies the return pointer of a method or function

@static

Specifies that the Guan Jianzi is static.

@var

Specify the variable type

 @version

Specify version information

 @todo

Indicate areas that should be improved or have not been implemented

 @throws

Indicates the error exception that this function may throw and the circumstances in which it occurs

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, represented by {@}, which specifically includes the following:

 {@link}

Usage is the same as @link

 {@source}

Display the content of a function or method

www.bkjia.comtruehttp: //www.bkjia.com/PHPjc/371748.htmlTechArticle@access Scope of use: class, function, var, define, module This tag is used to indicate the access of keywords Permissions: private, public or protected @author Specify the author @copyright Scope of use: c...
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