php中如何给类规范的注释？

Question

经常看到别人写的php库注释相当好，像这样

/**
* @param array $params parameters
* @param string $content contents of the block
* @param Smarty_Internal_Template $template template object
* @param boolean &$repeat repeat flag
* @return string content re-formatted
* @author Monte Ohrt <monte at ohrt dot com>
*/
想知道这种注释在哪有格式规定，用什么编辑器能快速生产这种注释，或者帮我写左边的*号。

Answer 1

标准请参考 PHPDoc标准以Zend Studio为例，你应该先完成代码，如function test(array $arr) {&nbsp;&nbsp;&nbsp;&nbsp;return $arr;}然后在function之前的一行敲入 /** 然后按回车，就会自动得到以下注释/**&nbsp;* //这行空白，留给你写功能说明的&nbsp;* @param array $arr&nbsp;* @return array&nbsp;*/当然，根据内容的不同注释也不一定，对文件注释，变量，属性，方法，函数，常量，类等都有自己的格式。例子123456789101112131415161718192021222324252627282930313233343536373839<?php/**&nbsp;* Project Form object, extends Zend_Form&nbsp;*&nbsp;* @author Nick <[e-mail]> 2012-4-18&nbsp;*/class&nbsp;Project_Form&nbsp;extends&nbsp;Zend_Form {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Options name of default values&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* @var string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*/&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;OPTIONS_DEFAULTE_VALUES =&nbsp;'defaults';&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Name of required attribute&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* @var string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*/&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;NAME_OF_ATTRIBUTE_REQUIRED =&nbsp;'required';&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Extend is valid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* @param array $data&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* @return void&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*/&nbsp;&nbsp;&nbsp;&nbsp;protected&nbsp;function&nbsp;_beforeIsValid(array&nbsp;$data) {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;$data;&nbsp;&nbsp;&nbsp;&nbsp;}&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/**&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Validate submitted data&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* @see Zend_Form::isValid()&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*/&nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;function&nbsp;isValid($data) {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;$data&nbsp;=&nbsp;$this->_beforeIsValid($data);&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;parent::isValid($data);&nbsp;&nbsp;&nbsp;&nbsp;}&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}