文件命名
程序的文件名和目录名都采用有意义的英文命名。
不使用拼音或无意义的字母。
只允许出现字母、数字、下划线、中划线字符。
多个词之间使用驼峰命名法。
//类统一采用
demoTest.class.php
//接口统一采用
demoTest.interface.php
普通变量命名
数据类型 | 命名规范 |
---|---|
字符串 | $strMyStr |
数组 | $arrMyArray |
对象 | $objMyObject |
布尔值 | $flagMyFlag |
采用驼峰命名,建议在变量前加上变量的类型作为前缀。
变量应该以名词为准,尽量避免使用常用关键字或存在模糊意义的单词。
私有变量,建议加上前缀"_"。
函数命名
函数名即要有意义,也要尽量缩写,一看就知道干什么。
建议单用动词或动词加形容词的格式命名。
私有方法,建议在加上前缀"_"。
//例如
private function _showMsg()
{
//方法体
}
习惯与约定
为了减少变量的长度,在不影响可读性的前提下,习惯对变量进行缩写。
全称 | 缩写 |
---|---|
image | img |
string | str |
database | db |
array | arr |
count | cnt |
message | msg |
password | passwd 或 pwd |
... | ... |
文件注释
/**
* 文件的简述
*
* PHP Version 6(PHP版本)
*
* @category 可以写部门(英文)
* @package 可以写模块(英文)
* @author test <test@company.com>
* @time 2017/02/02 11:48
* @copyright 2017 公司名称
* @license 公司网址 license
* @link test@qq.com(作者联系方式)
*/
类注释
/**
* 类的简述
*
* @category 可以写部门(英文)
* @package 可以写模块(英文)
* @author test <test@company.com>
* @license 公司网址 license
* @link test@qq.com(作者联系方式)
*/
方法注释
/**
* 方法的简述
* @param array $myArray 参数解释
* @param string $myString 参数解释
* @return array(返回数据类型)
*/
代码注释
注释写在被注释代码的前面,而不是后面,但对于单行语句,注释可写在语句末尾。
对于大段注释,使用 / / 进行注释。
注释不宜太多,大家能看的懂得行不必注释。
代码注释应该描述为什么,而不是做什么。
不要为了注释而注释。
标注的使用
IDE 支持一些特殊注释,可以列出整个项目中的特殊注释,方便后期维护和代码检查。
例如:
//@fixMe 表示需要修复项。
//@todo 表示需要完善的地方。