【讀書筆記】——《代碼大全》(六)
The Power of Variable Names
摘錄與總結一些有用的東西。
語義前綴
語義前綴 |
含義 |
c |
數量(count,如記錄、字符或者其他東西的個數) |
first |
數組中需要處理的第一個元素。first與min類似,但它是相對於當前操作而不是數組本身的 |
g |
全局變量(global variable) |
i |
數組的下標(index into an array) |
last |
數組中需要處理的最後一個元素 |
lim |
數組中需要處理的元素的上限 |
m |
類一級的變量 |
max |
數組或者其他種類的列表中絕對的最後一個元素。max反映的是數組本身,而不是針對數組的操作 |
min |
數組或者其他種類的列表中絕對的第一個元素 |
p |
指針 |
應該避免的名字
避免使用令人誤解的名字或縮寫
避免使用具有相似含義的名字
避免使用具有不同含義但卻有相似名字的變量
避免使用發音相近的名字,如wrap和rap
避免在名字中使用數字,如果數字非常重要,請用數組
避免在名字中拼錯單詞
避免使用英語中常常拼錯的單詞
不要僅靠大小寫來區分變量名,不是所有語言都是大小寫敏感的
避免使用多種自然語言
避免使用標準類型、變量和子程序的名字
不要使用與變量含義完全無關的名字
避免在名字中包含容易混淆的字符
Conclusion
好的變量名是提高程序可讀性的一項關鍵要素。對特殊種類的變量,比如循環下標和狀態變量,需要加以特殊的考慮;
名字要盡可能地具體,那些太模糊或者太通用以至於能夠用於多種目的的名字通常都是很不好的;
命名規則應該能夠區分局部數據、類數據還是全局數據,它們還應當可以區分類型名、具名常量、枚舉類型名字和變量名;
無論做哪種類型的項目,你都應該采用某種變量命名規則。你所采用的規則的種類取決於你的程序的規模,以及項目成員的人數。
盡量不要用縮寫,真的要用的話,請使用項目縮寫詞典或者標準前綴來幫助理解縮寫;
代碼的閱讀次數遠遠多於編寫的次數,確保你取的名字更側重於閱讀方便而不是編寫方便。
【讀書筆記】——《代碼大全》(六)