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) {

    return $arr;

}

然后在function之前的一行敲入 /** 然后按回车，就会自动得到以下注释

/**

 * //这行空白，留给你写功能说明的

 * @param array $arr

 * @return array

 */

当然，根据内容的不同注释也不一定，对文件注释，变量，属性，方法，函数，常量，类等都有自己的格式。

例子

123456789101112131415161718192021222324252627282930313233343536373839

<?php/** * Project Form object, extends Zend_Form * * @author Nick <[e-mail]> 2012-4-18 */class Project_Form extends Zend_Form {            /**     * Options name of default values     * @var string     */    const OPTIONS_DEFAULTE_VALUES = 'defaults';            /**     * Name of required attribute     * @var string     */    const NAME_OF_ATTRIBUTE_REQUIRED = 'required';            /**     * Extend is valid     * @param array $data     * @return void     */    protected function _beforeIsValid(array $data) {        return $data;    }            /**     * Validate submitted data     * @see Zend_Form::isValid()     */    public function isValid($data) {        $data = $this->_beforeIsValid($data);        return parent::isValid($data);    }        }