變量、函數(shù)、類的命名規(guī)則
更新時間:2011年08月14日 15:22:05 作者:
在閱讀clean code書籍的時候,讓我體會很多,因此我也用文字記錄下這些有意義的知識。我認為這本書讀十遍都不為過,下面我講解一下自己的關于變量、函數(shù)、類的命名規(guī)則筆記。
1、命名要名副其實:
命名的時候一定要考慮他的顯示意義和語境,不要認為把時間花費在變量的命名上很浪費。當然如果你程序很短的話,就不需要考慮那么多了,埋頭就寫代碼。如果你的項目大,而且文件多的情況下,最好就是要花費時間在命名上,因為你的代碼不僅僅只是你一個人看的。
2、避免誤導:
也就是說不要把其他平臺的關鍵字拿來命名,比如說我使用javascript語言,而我設計了一個變量為int,這讓人會很頭疼,為什么要一個int變量呢,難道這段代碼是C++。這樣就會讓人產(chǎn)生誤導。如果你想一個整型變量你可以這樣,var intNumber;
3、做有意義的區(qū)分:
variable:永遠不要拿來作為變量的名稱、table永遠不要拿來作為表的名稱,等等。不要使用相似的命名,必須做有意義的區(qū)分,比如說:有一組變量,有些童鞋會這樣命名,a1、a2、a3...,而如果我們根據(jù)他們的作用來命名效果會好很多。
4、使用容易讀懂的名稱:
最好就是使用一段英文,或者英文短語,切莫一些中文,一些英文混合,或者單純的中文。比如:我們想寫一個函數(shù)作用是,切換語言:qieHuanYuYan,這樣的話大家讀起來就會一個個的去拼寫,而且最后還不一定能夠拼寫成功,如果改為:changeLanguage效果會好很多。
5、使用可搜索的名稱:
我建議大家在使用阿拉伯數(shù)字的時候,最好能在代碼的最開始,使用大寫加下劃線定義。比如說50度是一個人體能夠承受的電力最大福特越界值,那么我們可以命名為:PEOPLE_MAX_VOLTA;當然我英語能力有點不好,但是基本是這個原理。如果單純的使用50的話,會讓人不知道這個是什么標準,如果變成變量就容易閱讀。而且大家最好不要使用單個的英文字母,因為那樣會造成相當大的麻煩,不僅僅是搜索,而且也難易理解。
6、避免使用編碼:
不要使用一些前綴命名,比如說加一個m_之類的,這樣雖然可以多次命名,但是會讓人難以讀懂。
7、避免思維映射:
避免單個名稱,明確才是王道,不要以為你的單個名稱別人看不懂,你就很牛逼。如果代碼看起來像看小說一樣,那才叫牛逼。
8、類名、方法名
類名應當是名詞、或者名詞短語。例如:Customer、WikiPage,避免使用Maneger、Perocessor這類帶有動作的詞語;方法名,盡量的能夠體現(xiàn)出這個方法的動作,所以最好使用動詞,或者動詞短語,例如:postMail、deletePage,等等。
9、每個概念對應一個詞:
給每個抽象概念選一個詞并且一以慣之,例如使用get、方法,getMsg()、getUsername()、getUerId()等等。
10、不要使用雙關語:
避免同一個單詞用于不同的目的,比如說add這個就不是很好,可以使用append這類詞語替換他。
11、添加語境:
就是給一些變量或者函數(shù)一些語境,比如說:這段變量,firstName、lastName、street、state,這些東西看起來我們都明白,但是我們都不知道他是描述什么的,如果加上address,改為;addressFirstName、addressLastName、addressStreet、addressState,這樣的話就明朗很多了。
大家在對變量、函數(shù)、類命名的時候一定不要害怕他很長,只要能夠讀懂就好,當然如果短能夠描述的清楚的話,還是必須得選擇短的,我是想說如果想描述清楚,不要害怕變量、函數(shù)、類的命名太長。
命名的時候一定要考慮他的顯示意義和語境,不要認為把時間花費在變量的命名上很浪費。當然如果你程序很短的話,就不需要考慮那么多了,埋頭就寫代碼。如果你的項目大,而且文件多的情況下,最好就是要花費時間在命名上,因為你的代碼不僅僅只是你一個人看的。
2、避免誤導:
也就是說不要把其他平臺的關鍵字拿來命名,比如說我使用javascript語言,而我設計了一個變量為int,這讓人會很頭疼,為什么要一個int變量呢,難道這段代碼是C++。這樣就會讓人產(chǎn)生誤導。如果你想一個整型變量你可以這樣,var intNumber;
3、做有意義的區(qū)分:
variable:永遠不要拿來作為變量的名稱、table永遠不要拿來作為表的名稱,等等。不要使用相似的命名,必須做有意義的區(qū)分,比如說:有一組變量,有些童鞋會這樣命名,a1、a2、a3...,而如果我們根據(jù)他們的作用來命名效果會好很多。
4、使用容易讀懂的名稱:
最好就是使用一段英文,或者英文短語,切莫一些中文,一些英文混合,或者單純的中文。比如:我們想寫一個函數(shù)作用是,切換語言:qieHuanYuYan,這樣的話大家讀起來就會一個個的去拼寫,而且最后還不一定能夠拼寫成功,如果改為:changeLanguage效果會好很多。
5、使用可搜索的名稱:
我建議大家在使用阿拉伯數(shù)字的時候,最好能在代碼的最開始,使用大寫加下劃線定義。比如說50度是一個人體能夠承受的電力最大福特越界值,那么我們可以命名為:PEOPLE_MAX_VOLTA;當然我英語能力有點不好,但是基本是這個原理。如果單純的使用50的話,會讓人不知道這個是什么標準,如果變成變量就容易閱讀。而且大家最好不要使用單個的英文字母,因為那樣會造成相當大的麻煩,不僅僅是搜索,而且也難易理解。
6、避免使用編碼:
不要使用一些前綴命名,比如說加一個m_之類的,這樣雖然可以多次命名,但是會讓人難以讀懂。
7、避免思維映射:
避免單個名稱,明確才是王道,不要以為你的單個名稱別人看不懂,你就很牛逼。如果代碼看起來像看小說一樣,那才叫牛逼。
8、類名、方法名
類名應當是名詞、或者名詞短語。例如:Customer、WikiPage,避免使用Maneger、Perocessor這類帶有動作的詞語;方法名,盡量的能夠體現(xiàn)出這個方法的動作,所以最好使用動詞,或者動詞短語,例如:postMail、deletePage,等等。
9、每個概念對應一個詞:
給每個抽象概念選一個詞并且一以慣之,例如使用get、方法,getMsg()、getUsername()、getUerId()等等。
10、不要使用雙關語:
避免同一個單詞用于不同的目的,比如說add這個就不是很好,可以使用append這類詞語替換他。
11、添加語境:
就是給一些變量或者函數(shù)一些語境,比如說:這段變量,firstName、lastName、street、state,這些東西看起來我們都明白,但是我們都不知道他是描述什么的,如果加上address,改為;addressFirstName、addressLastName、addressStreet、addressState,這樣的話就明朗很多了。
大家在對變量、函數(shù)、類命名的時候一定不要害怕他很長,只要能夠讀懂就好,當然如果短能夠描述的清楚的話,還是必須得選擇短的,我是想說如果想描述清楚,不要害怕變量、函數(shù)、類的命名太長。
相關文章
linux系統(tǒng)使用vscode進行qt開發(fā)的過程分享
最近在Linux上搞Qt,搞的一頭霧水,小編把整個過程記錄下,分享需要的朋友,如果大家對linux系統(tǒng)使用vscode進行qt開發(fā)相關知識感興趣的朋友跟隨小編一起看看吧2021-12-12Git撤銷已經(jīng)推送(push)至遠端倉庫的提交(commit)信息操作
這篇文章主要介紹了Git撤銷已經(jīng)推送(push)至遠端倉庫的提交(commit)信息操作,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-09-09