代碼精進(jìn)之路:從碼農(nóng)到工匠

chapter1: 命名

變量名:變量名應(yīng)該是名次,能夠正確的表述業(yè)務(wù),有表達(dá)力。如果一個變量名需要注釋來補充說明,那么這個命名是有問題的。

函數(shù)名:函數(shù)命名要具體,空泛的命名沒有意義。比如,processData()就不是一個好的命名,因為并沒有表明要做的事情。相比之下,validateUserCredentials()就好很多。函數(shù)命名要體現(xiàn)做什么,而不是怎么做。比如要從棧中獲取最近存儲的一個雇員信息,那么getLastestEmployee()就比popRecord()要好。

類名:類是面向?qū)ο笞钪匾母拍钪?,是一組數(shù)據(jù)和操作的封裝。對于一個應(yīng)用系統(tǒng),我們可以分為兩大類:實體類和輔助類。實體類承載了核心業(yè)務(wù)數(shù)據(jù)和核心業(yè)務(wù)邏輯,其命名要充分體現(xiàn)業(yè)務(wù)語義,并在團(tuán)隊內(nèi)達(dá)成共識。如customr,bank。輔助類是輔佐實體類一起完成業(yè)務(wù)邏輯的,其命名要能夠通過后綴來體現(xiàn)功能。

包名:包的命名要適中,不能太抽象,也不能太具體。

保持命名的可讀性和一致性。

每個概念一個詞。


方法名約定

遵守對仗詞的命名規(guī)則有助于保持一致性,從而提高代碼的可讀性。

后置限定詞:很多程序中會有表示計算結(jié)果的變量,例如Total,Sum,Average,Max,Min。如果要用這些定詞來修改某個命名,那么記得把限定詞加在名字的最后,并且貫徹執(zhí)行,保持命名風(fēng)格的一致性。

好的代碼是最好的文檔。

通過添加中間變量讓代碼變得更加自明。即將計算過程打散成多個步驟,并用有意義的變量名來命名中間變量,從而把隱藏的計算過程以顯性化的方式表達(dá)出來。

注釋的作用不是復(fù)述代碼的功能,而是解釋代碼背后的原因。

Chapter2: 規(guī)范

Java的命名約定:

類名采用大駝峰形式,即首字母大寫,如StringBuffer

方法名采用小駝峰形式,即首字母小寫的動詞形式

常量命名的字母全大寫,單詞之間用下劃線鏈接

Chapter3: 函數(shù)

函數(shù):函數(shù)是一組代碼的集合,是程序中最小的功能模塊,一次函數(shù)調(diào)用包括接收參數(shù)輸入,數(shù)據(jù)處理,返回結(jié)果。

函數(shù):單一職責(zé)原則SRP。遵守SRP不僅可以提升代碼的可讀性,還能提升代碼的可復(fù)用性。

Chapter4:設(shè)計原則

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容