PHP development coding standards /PHP函数和方法的注释

PHP函数和方法的注释

PHP函数和方法的注释


函数和方法的注释写在函数和方法的前面,采用类似下面例子的规则:

/** * @Purpose: * 执行一次查询 * @Method Name: Query() * * @Param: string $queryStr SQL查询字符串 * @Param: string $username 用户名 * * @Author: Michael Lee * * @Return: mixed 查询返回值(结果集对象) */ function($queryStr,$username) {……}