#可读性
我们是一个团队在写代码,要做到代码不仅自己能看懂,别人也能看懂,团队需要约定一个编码规范,让大家写的代码风格一致,让团队中所有人都能看懂代码。
在命名规范上,做到函数名、类名、变量名、数据库表名、字段名不要是拼音声母缩写,尽量用英文。如果用拼音声明缩写,可能过段时间连自己也不明白某个变量的意思。
要勤于写代码注释,代码注释有利于团队其他成员阅读你的代码。对于逻辑复杂的代码模块建议大家先写注释后写代码,注释写清楚每一步做什么,这样在写注释的时候就可以理清逻辑,然后再写代码。 比如我们写用户登录模块,我们可以先写注释
```
//第一步:获得用户名,密码
//第二步:查询用户名是否存在
//第三步:对比密码是否正确
```
写好注释后,再在注释之下写具体的代码
```
//第一步:获得用户名,密码
$username=$_POST['username'];
$password=$_POST['password'];
//第二步:查询用户名是否存在
$user=M('User')->where("`username`='%s'",$username)->find();
if(!$user){
$this->error('用户不存在');
}
//第三步:对比密码是否正确
if($user['password']!=md5($password)){
$this->error('密码不正确');
}
$this->success('登录成功');
```
调试代码可以加上//debug的注释,这样在程序上线之前可以批量搜索一下程序中是否含有//debug注释,如果有发现调试代码没有删除,需要删除这些调试代码再上线。
各个编程语言都有官方推荐的编码规范,大家可以网上找一下对应语言的规范,然后学习一下。比如PHP推荐的规范是PSR规范:https://github.com/PizzaLiu/PHP-FIG