文档介绍：PHP 开发基础编码规范制定人:郑书发 20160118 1、方法命名规则: A、采用骆驼式规则命名,如: createProject 、 findProjectList. B、取名尽量让人容易理解。要求采用动名词驱动模式,如: createProject 、 findBindings C、方法为读取单个数据,命名规则为: get+ 名词,如: getProject ,读取结果为多个数据时为: find+ 名词复数,如 findProjects , searchProjects, etc 。 D、必须要写注释,注明函数功能或用意,并对参数给出解释。 2、方法参数命名规则: A、采用骆驼式规则命名。 B、参数取名尽量简介明了。 C、在方法注释中给出参数说明,格式为标准格式,如: ***@param int $id :项目 ID 3、注释 A、类文件注释实例如: /** * 帐户资金模型* 完成用户相关功能:如: CRUD * ***@copyright 9-2012 * ***@author ZhengShuFa: 郑书发*@ createdate : 2009-07-08 * ***@version */ 编码规范: 1、说明用处,若是对外接口需详细说明调用方式 2、***@copyright 所有权 3、***@author 作者 4、@ createdate 创建时间 5、***@version 版本,做出重大修改时,需要在此注明 B、类属性注释实例: /** * ***@var 网站框架显示模板*/ public $template = 'common/template'; ***@var 说明类属性的用处 C、类方法注释/** * 读取最新文章列表* ***@author zhengshufa * ***@param string $method 参数详细说明* ***@param array $params 参数详细说明* ***@return array 返回结果说明( 作为对外接口时需详细说明返回的数据结构) */ 说明:类方法的说明***@author 作者,当与类作者是同一人时可以省略***@param 参数说明。类型+ 名称+ 文字说明***@return 返回值类型以及说明