軟件開發(fā)中的 5S 原則:
- 整理:命名的規(guī)范
- 整頓:把你的代碼放在它應(yīng)該在的地方
- 清楚:整潔代碼
- 清潔:代碼風(fēng)格、實踐手段
- 身美:不斷改進(jìn)
有意義的命名
- 變量名米碰、方法名:使用小駝峰法 --- 除第一個單詞之外晦毙,其他單詞首字母大寫
eg:
var myStudents;
function getStudentById(){}
- 類名:使用大駝峰法 --- 所有單詞的首字母都大寫
eg:
class BaseUser{}
好的命名遵循下列的規(guī)范:
- 名副其實:不需要被注釋也應(yīng)該被理解涣雕、看懂载佳。怎么用橄务、做什么事、為什么存在
- 避免誤導(dǎo):(I 颗管、O)陷遮,這到底是 I 還是 1,是 O 還是 0;(傻傻分不清)
- 做有意義的區(qū)分:
不要使用 a1垦江、a2拷呆、a3
不要說廢話(student 就不要再寫成 studentInfo 或者 studentData 了) - 使用讀得出來的名稱
- 使用可搜索的名稱:不要使用硬編碼,盡量使用常量替代
- 一致的命名規(guī)則:比如查找都用 find**
- 不要使用雙關(guān)語
明了的函數(shù)
- 短小
- 每一個函數(shù)/方法應(yīng)該只干一件
- 函數(shù)參數(shù):
一元參數(shù):有輸入應(yīng)該也有輸出
二元參數(shù):盡量不要使用疫粥,除非參數(shù)是有序組成的(new Point(x,y))
如果參數(shù)個數(shù)超過兩個茬斧,考慮下把參數(shù)封裝一下在傳過去 - 別重復(fù)自己
注釋
法律信息
提供信息的注釋(時間格式...)
對意圖的解釋
警告
TODO
公共 API