写代码规范
1.变量使用下划线命名法。比如:$stu_name
2.函数使用下划线命名法。比如:function get_user_info()
3.类名使用大驼峰式命名法。比如:class ClassInfo
4.私有属性使用下划线命名法,并且以_开头。比如:private $_telphone;
5.私有方法,使用小驼峰式命名法,并且以_开头。比如:private function _doSomething()
6.常量使用下划线命名法,所有字母都为大写字母。比如:define('BLOG_URL','http://blog.kunx.org')
7.类文件名和类名应当强相关,文件以.class.php作为后缀。比如:ClassInfo类对应的文件是:ClassInfo.class.php
8.变量命名应当有意义,严禁使用$a,$b之类的命名。
9.临时变量使用完毕,及时销毁。
10.第一个大括号不换行,最后一个大括号单独成行(除else elseif前的}),第一个大括号之前有一个空格。比如:
function get_user_info() {
}
11.条件分支语句必须写{}哪怕只有一行。比如:
if($age<18) {
echo '未成年';
}else{
echo '成年人';
}
12.单行注释使用//,不准使用#,并且双斜线后有一个空格.
13.多行注释使用/**开头,使用*/结尾,要对齐。比如:
/**
* 这是注释
*/
14.文件必须有文件说明,比如:
/**
* Description:本文件是User控制器文件,用于执行用户相关的操作,包括用户的增删改查操作。
* Author:四哥
* Date:2016-3-25
*/
class UserController{
}
?>
15.函数和方法必须有注释,并且需要标出函数作用以及参数和返回值类型、含义。比如:
/**
* 自定义加盐加密算法。
*
* @param string $password 原密码。
* @param string $salt 加密因子。
*
* @return string 加盐加密后的字符串。
*/
function my_mcrypt($password,$salt){
return md5(md5($password).$salt);
}
16.如果函数或方法有类型约束,必须在形参前定义。比如:
function get_goods_sell_price(array $goods_info){
return $goods_info['shop_price'] * $goods_info['discount'];
}
17.如果一个文件以?>结尾,将?>删除。
18.函数和方法前有一行空行。
19.缩进,所有缩进应当使用4个空格, 基本上所有的IDE都可以设置。
20.一个函数或者一个方法,代码限定在50行以内,最多不能超过80行,如果代码太多,就尽量拆分成几个函数或方法。