Automatically generate PHP document tool phpdocument in the API documentation for tag annotation style highlights.
Website API Link:
HTTPS://docs.phpdoc.org/references/phpdoc/index.html
Example: From the above look is very messy annotation style, very random, a little low, and now the specification, in http://php.net/manual/zh/did not find the annotated style of the chapter description, then the Open Source Tool phpdoc The annotation style is good.
Since the Phpdoc documentation is a lot of and a lot of useless, the site is relatively slow to open, then a more commonly used comment template here
But has always been to @method (in fact, used to explain the function of the Magic method called inside) to declare the method name, think, there is no problem haha, happy, the general specification is good, lest the farther away, hey
Common but method name, parameter, author, return value, example:
/* * * Test method * @author My Name <[email protected]> * @link /index/test * @param $_post[' Pronum ']; Number of goods int * @param [Type] [name] [<description>] * @param [int] [$_post[' proid ']] [< commodity id>] * @copyright 2017-12-16 PHP Group * @return [array] [return {' Status ' when successful: true, ' data ': ' Success ', ' Code ': 0}] * @ Example example description, text array, etc. DIY * @version 1.0.1* /function test () { ' I am Test ' ; }
Reference blog:
HTTPS://www.cnblogs.com/hellohell/p/5733712.html
Phpdoc Document tool annotation style collation