总结总结PHP代码规范、流程规范、代码规范、流程规范、git规范规范
内容我们整理总结了关于PHP代码规范、流程规范、git规范的详细内容,对此有兴趣的朋友可以学习下。
代码规范、git规范、teambition规范、yii规范
1. 命名规范
(1).变量命名规范变量命名规范
1.变量使用驼峰命名法 禁止使用拼音或者拼音加数字
2.变量也应具有描述性,杜绝一切拼音、或拼音英文混杂的命名方式
3.变量包数字、字母和下划线字符,不允许使用其他字符,变量命名最好使用项目 中有据可查的英文缩写方式, 尽可以要使
用一目了然容易理解的形式;
4.变量以字母开头,如果变量包多个单词,首字母小写,当包多个单词时,后面 的每个单词的首字母大写.例如 :$itSports
5.变量使用有效命名
例如评论:$commentArr
6.变量属性标记清楚
例如 数组变量后加Arr :$commentArr,数值: $commentInt
7.变量除了在循环体(for,foreach,while)中,其他位置允许但不鼓励使用没有描述意义的字母作为变量名。
例如:$i,$j。
(2).常量命名规范常量命名规范
1.常量名应具有描述性,杜绝一切拼音、或拼音英文混杂的命名方式
2.常量名包字母字符和下划线,不允许使用数字和其他字符。
3.PHP 的内建值 TRUE、FALSE 和 NULL 必须全部采用大写字母书写。
4.常量名所有字母必须大写,少数特必要的情况下,可使用划线来分隔单词。
例如: define(‘AAA_BBB_CCC', ‘true'); (如果常量名由 aaa, bbb, ccc 三个单词组成 的)
define('NAME','root')
(3).类名命名规范类名命名规范
1.一个文件中声明一个类,文件名中必须包类名字符串,这些不仅容易查找,也有 利于实现在程序中自动加载类。
2.类名应有描述性,杜绝一切拼音、或拼音英文混杂的命名方式
3.类名包括字母字符,不允许使用数字和其他字符
4.如果类名包括多个单词,应使用驼峰式命名方式,每个单词的第一个字母必须大写, 不允许连续大写。
类 首字母大写 如 : class Comment{}
AaaBbbCcc (如果类名由 aaa, bbb, ccc 三个单词组成的)
(4).方法命名规范方法命名规范
1.函数名应具有描述性,杜绝一切拼音、或拼音英文混杂的命名方式
2.函数名包括字母字符,不允许使用数字和其他字符。
3.函数名首字母小写,当包多个单词时,后面的每个单词的首字母大写.
例如: aaaBbbCcc (如果函数名由 aaa, bbb, ccc 三个单词组成的)
4.函数名应带有get,set等动作性描述。
function getUser(){ //函数内容 } 方法,函数有效命名 :function getCommentIdByTableName(){}
5.可以声明像函数名前带有下划线的形式,表示该函数为该类的私有方法,外部不允许进行访问。
例如:function _func(){}
2. 代码注释