《代碼整潔之道》第2章筆記——有意義的命名

     在一個程序中,有意義的變量、函數或者類的命名有意義,能夠顧名思義,非常重要。如果名稱需要註釋來補充,那就不算是名副其實。




對以上代碼段的變量進行重新命名後得到以下代碼段。 




       注意,以上的代碼簡潔性並未被觸及,裏邊的運算符和常量的數量全然不變,只是修改了變量的名稱,但代碼變得明確多了。


       避免誤導:程序員必須避免留下掩藏代碼本意的錯誤線索。別用accountList 來指稱一組賬號,除非它真的是List類型。提防使用不同之處較小的名稱。誤導性名稱是可怕的,例如用小寫字母l 和大寫字母 O 作爲變量,在代碼中看起來會想常量 “1”和“0”,很容易混淆。


       做有意義的區分:假設你有一個Product 類,另外還有一個ProductInfo或者ProductData類,那他們的名稱雖然不同,意思卻無區別。Info和Data就像a、an、the一樣,是意義含混的廢話。Variable一詞永遠不應出現在變量名中,Table一詞永遠不應當出現在表名中。


       使用讀得出來的名稱:比較以下段代碼  

         

      使用可以搜索到的名稱:長名稱勝於短名稱,搜得到的名稱勝於用自造編碼代寫就得名稱。若變量或者常量可能在代碼中多處使用,則賦其便於搜索到的名稱。


     1.類名和對象名應該是名稱或者是名詞短語,類名不應當是動詞。而方法名應當是動詞或者是動詞短語。

     2.函數名稱應當是獨一無二的,而且要保持一致。

     3.避免將同一單詞用於不同的目的,同一術語用於不同的概念。

     4.添加有意義的語境,你需要用良好命名的類、函數或者名稱空間來放置名稱,給讀者提供語境。如果沒這麼做,給名稱添加前綴是最後一招了。但不要添加沒用語境,只要短名稱足夠清楚,就要比長名稱好。


第一寫的博客。

     



發佈了35 篇原創文章 · 獲贊 0 · 訪問量 5萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章