PHP Annotation Specification

Annotations are important in the process of writing code, and good annotations make your code easier to read, so be sure to note the specification when writing code.

Add comments to the code in the future to develop a good habit. Especially when doing projects for customers, be sure to add.

There are several common annotation methods in PHP:

1. File header comments, introduction of file name, function and author version number and other information

/* * * file name Simple description * * Document function. * @author      Alvin Author * @version     1.0 Version Number * * 

2. Function comment, function, parameter introduction and return type

/* * * The   meaning of the function description * * @access public * @param mixed $arg 1 parameter one of the description * @param mixed $arg 2 parameter two description * @param mixed $mixed This is a mixed Type * @return array return type  */

3. Class comment, class name and introduction

/* * * Class INTRODUCTION * * Class details (optional.) ）。 * @author      Alvin Author * @version     1.0 Version Number * * 

4. Multi-line annotations

/* PHP Comment Syntax   This is a multi-line comment. */

5. Single-line Comment

$n // Quantity N, this is a single-line comment

PHP Annotation Specification