Phpdoc Instructions for use

Technical documentation can make it easier for people to use someone else's code base, but as a developer, writing documents is a daunting task. Phpdoc is a standard for PHP documentation comments that can be implemented as a code generation API document.

Phpdoc Annotation Specification:

The start and end flags for block annotations are "/**", "*/", which must be followed by the annotated function, as follows:

1 /* * 2 * Block Comment 3  */ 4   Public foo () 5 {6 }

View Code

The block annotations can contain tags:

In addition, in Phpstorm, you can pass:

1, Code->generate->phpdoc Blocks ... Automatically generate comments for Phpdoc

2. File->settings->file and Code Templates Modify the comment template

Resources:

1, Http://wenku.baidu.com/link?url= Ql1sc-s1hcfhezyfogbtsr2riuyjed-gvzhyu-ca2l0nxh3oatksywiilzzhp1usk35gnurmm-sheklqqjsd_xqm5j99ga3yc18fyq7x4vg

2, http://www.cnblogs.com/picaso/archive/2012/10/04/2711435.html

3, Http://en.wikipedia.org/wiki/Phpdoc

Phpdoc Instructions for use