Table of Contents
Preface
Common tags
@param
Description
Code example
@return
@deprecated
@see
Explanation
@link
Code examples
@link&@see difference
@var
Variable list
Home Backend Development PHP Tutorial Comment tags that every PHPer should master!

Comment tags that every PHPer should master!

Dec 03, 2020 pm 05:43 PM
php Comment

Recommended: "PHP Video Tutorial"

Preface

Comment tags play a very important role in code comments Large and good annotation tags can give you a better and more comfortable experience in the programming process, so today I am going to sort out these tags and display them in the form of pictures and texts. On the one hand, it is to help myself understand these annotation tags. A summary. On the other hand, I also hope that everyone can better understand the comment tags

Everyone hopes to write beautiful code. Maybe you are only one tag away from beautiful code

Common tags

# #Static variables used in classes and functions@subpackage@throws@todo@var@version

A lot of the above are actually needed to be added when creating files and classes. Today I will mainly explain the commonly used tags.

@param

Description

Parameters, used for tags in function and method comments\
Format@param [Type] [name] [&lt ;description>]\
For example@param string title Article title

Code example

Comment tags that every PHPer should master!

@return

Description

Return value
Format @return [type] []]
For example @return array result array

Code example

Comment tags that every PHPer should master!

@deprecated

Description

Not recommended, expired, and will be deleted\
Format@ deprecated [<version number>] [<description>]</description></version>\
For example@deprecated 1.0.0 New versions will no longer contain this function\
if it is Replaced by other methods, it is recommended to add @see tag

Code example

Comment tags that every PHPer should master!

@see

Explanation

Reference, similar to @link, can be linked with @deprecated
Format @see [url or complete method name] []
For example @see \yii\base\db: :tableName() The old method table_name has been deprecated, please use this method instead

Code example

Comment tags that every PHPer should master!

@link

Description

Links can be used to assist explanations, reference documents, etc.\
Format@link [url] [<description>]</description>\
For example@link http:/ /g.cn If you don’t understand, go ask Google and don’t bother me

Code examples

Comment tags that every PHPer should master!

@link&@see difference

Tag Use Description
@abstract
Variables and methods of abstract classes
@access public , private or protected Access and usage rights of the document. @access private indicates that the document is protected.
@author 张三zhangsan@163.com Document author
@copyright Name time Document copyright information
@deprecated version Deprecated method in the document
@deprec
Same as @deprecated
@example /path/to/example The location of the example file saved externally to the document.
@exception
For exceptions thrown by methods in the document, you can also refer to @throws.
@global Type: $globalvarname Global variables and related methods and functions in the document
@ignore
Ignore keywords specified in the document
@internal
Development Team internal information
#@link URL Similar to license but you can also find more detailed information in the document through the link
@name Variable alias Specify an alias for a variable
@magic
phpdoc.de compatibility
@package The name of the encapsulated package A set of related classes, Function encapsulated package name
@param such as $username username variable meaning comment
@return If the function returns a bool function returns a description of the result, it is generally not used in a void (empty return result) function
@see Such as Class Login() Any element associated with the file (global variables, including pages, classes, functions, definitions, methods, variables).
@since version Record when changes were made to which parts of the document
@static
Record static classes and methods
@staticvar

##Sub version

Exception thrown by a certain method

Indicates areas where the file is incomplete or needs to be improved
type Variables in the document and their types

Version information of documents, classes, and functions
- @see @link
External link
Internal program X

@var

Description

Variable\
Format@var [Type] [Variable name] [<description>]</description>\
For example@var int id user id

Variable list

##float/doublenumber/floating point numberobjectObject instancespecifiedTypeSpecified classmixedAny typearray/specifiedType[]Array, can be specified as an array of the specified typeresourceFile resource typevoidNo return valuenull-callableExecutable callback functionfunctionNo A method that must be executedself/$thisCurrent instance
Variable type Description
string String
integer/int number/int type
boolean/bool false/true
Code example

1. Variable definition outside the method


Comment tags that every PHPer should master!2. Variable definition inside the method

Comment tags that every PHPer should master!

@throws

Description

Types of errors that may be thrown\

Format
@throws [Type] []\For example
@throws Exception

##                                                                 

The above is the detailed content of Comment tags that every PHPer should master!. For more information, please follow other related articles on the PHP Chinese website!

Statement of this Website
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

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

Hot Topics

Java Tutorial
1664
14
PHP Tutorial
1267
29
C# Tutorial
1239
24
Explain JSON Web Tokens (JWT) and their use case in PHP APIs. Explain JSON Web Tokens (JWT) and their use case in PHP APIs. Apr 05, 2025 am 12:04 AM

JWT is an open standard based on JSON, used to securely transmit information between parties, mainly for identity authentication and information exchange. 1. JWT consists of three parts: Header, Payload and Signature. 2. The working principle of JWT includes three steps: generating JWT, verifying JWT and parsing Payload. 3. When using JWT for authentication in PHP, JWT can be generated and verified, and user role and permission information can be included in advanced usage. 4. Common errors include signature verification failure, token expiration, and payload oversized. Debugging skills include using debugging tools and logging. 5. Performance optimization and best practices include using appropriate signature algorithms, setting validity periods reasonably,

Explain late static binding in PHP (static::). Explain late static binding in PHP (static::). Apr 03, 2025 am 12:04 AM

Static binding (static::) implements late static binding (LSB) in PHP, allowing calling classes to be referenced in static contexts rather than defining classes. 1) The parsing process is performed at runtime, 2) Look up the call class in the inheritance relationship, 3) It may bring performance overhead.

PHP Program to Count Vowels in a String PHP Program to Count Vowels in a String Feb 07, 2025 pm 12:12 PM

A string is a sequence of characters, including letters, numbers, and symbols. This tutorial will learn how to calculate the number of vowels in a given string in PHP using different methods. The vowels in English are a, e, i, o, u, and they can be uppercase or lowercase. What is a vowel? Vowels are alphabetic characters that represent a specific pronunciation. There are five vowels in English, including uppercase and lowercase: a, e, i, o, u Example 1 Input: String = "Tutorialspoint" Output: 6 explain The vowels in the string "Tutorialspoint" are u, o, i, a, o, i. There are 6 yuan in total

What are PHP magic methods (__construct, __destruct, __call, __get, __set, etc.) and provide use cases? What are PHP magic methods (__construct, __destruct, __call, __get, __set, etc.) and provide use cases? Apr 03, 2025 am 12:03 AM

What are the magic methods of PHP? PHP's magic methods include: 1.\_\_construct, used to initialize objects; 2.\_\_destruct, used to clean up resources; 3.\_\_call, handle non-existent method calls; 4.\_\_get, implement dynamic attribute access; 5.\_\_set, implement dynamic attribute settings. These methods are automatically called in certain situations, improving code flexibility and efficiency.

PHP and Python: Comparing Two Popular Programming Languages PHP and Python: Comparing Two Popular Programming Languages Apr 14, 2025 am 12:13 AM

PHP and Python each have their own advantages, and choose according to project requirements. 1.PHP is suitable for web development, especially for rapid development and maintenance of websites. 2. Python is suitable for data science, machine learning and artificial intelligence, with concise syntax and suitable for beginners.

PHP in Action: Real-World Examples and Applications PHP in Action: Real-World Examples and Applications Apr 14, 2025 am 12:19 AM

PHP is widely used in e-commerce, content management systems and API development. 1) E-commerce: used for shopping cart function and payment processing. 2) Content management system: used for dynamic content generation and user management. 3) API development: used for RESTful API development and API security. Through performance optimization and best practices, the efficiency and maintainability of PHP applications are improved.

PHP: A Key Language for Web Development PHP: A Key Language for Web Development Apr 13, 2025 am 12:08 AM

PHP is a scripting language widely used on the server side, especially suitable for web development. 1.PHP can embed HTML, process HTTP requests and responses, and supports a variety of databases. 2.PHP is used to generate dynamic web content, process form data, access databases, etc., with strong community support and open source resources. 3. PHP is an interpreted language, and the execution process includes lexical analysis, grammatical analysis, compilation and execution. 4.PHP can be combined with MySQL for advanced applications such as user registration systems. 5. When debugging PHP, you can use functions such as error_reporting() and var_dump(). 6. Optimize PHP code to use caching mechanisms, optimize database queries and use built-in functions. 7

Explain the match expression (PHP 8 ) and how it differs from switch. Explain the match expression (PHP 8 ) and how it differs from switch. Apr 06, 2025 am 12:03 AM

In PHP8, match expressions are a new control structure that returns different results based on the value of the expression. 1) It is similar to a switch statement, but returns a value instead of an execution statement block. 2) The match expression is strictly compared (===), which improves security. 3) It avoids possible break omissions in switch statements and enhances the simplicity and readability of the code.

See all articles