#可讀性
我們是一個團隊在寫代碼,要做到代碼不僅自己能看懂,別人也能看懂,團隊需要約定一個編碼規范,讓大家寫的代碼風格一致,讓團隊中所有人都能看懂代碼。
在命名規范上,做到函數名、類名、變量名、數據庫表名、字段名不要是拼音聲母縮寫,盡量用英文。如果用拼音聲明縮寫,可能過段時間連自己也不明白某個變量的意思。
要勤于寫代碼注釋,代碼注釋有利于團隊其他成員閱讀你的代碼。對于邏輯復雜的代碼模塊建議大家先寫注釋后寫代碼,注釋寫清楚每一步做什么,這樣在寫注釋的時候就可以理清邏輯,然后再寫代碼。 比如我們寫用戶登錄模塊,我們可以先寫注釋
```
//第一步:獲得用戶名,密碼
//第二步:查詢用戶名是否存在
//第三步:對比密碼是否正確
```
寫好注釋后,再在注釋之下寫具體的代碼
```
//第一步:獲得用戶名,密碼
$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