變量、函數(shù)袍嬉、類的命名規(guī)則

1境蔼、命名要名副其實:

命名的時候一定要考慮他的顯示意義和語境,不要認為把時間花費在變量的命名上很浪費伺通。當(dāng)然如果你程序很短的話箍土,就不需要考慮那么多了,埋頭就寫代碼罐监。如果你的項目大吴藻,而且文件多的情況下,最好就是要花費時間在命名上笑诅,因為你的代碼不僅僅只是你一個人看的调缨。

2、避免誤導(dǎo):

也就是說不要把其他平臺的關(guān)鍵字拿來命名吆你,比如說我使用javascript語言弦叶,而我設(shè)計了一個變量為int,這讓人會很頭疼妇多,為什么要一個int變量呢伤哺,難道這段代碼是C++。這樣就會讓人產(chǎn)生誤導(dǎo)者祖。如果你想一個整型變量你可以這樣立莉,var intNumber;

3七问、做有意義的區(qū)分:

variable:永遠不要拿來作為變量的名稱蜓耻、table永遠不要拿來作為表的名稱,等等械巡。不要使用相似的命名刹淌,必須做有意義的區(qū)分饶氏,比如說:有一組變量,有些童鞋會這樣命名有勾,a1疹启、a2、a3...蔼卡,而如果我們根據(jù)他們的作用來命名效果會好很多喊崖。

4、使用容易讀懂的名稱:

最好就是使用一段英文雇逞,或者英文短語荤懂,切莫一些中文,一些英文混合喝峦,或者單純的中文势誊。比如:我們想寫一個函數(shù)作用是,切換語言:qieHuanYuYan谣蠢,這樣的話大家讀起來就會一個個的去拼寫,而且最后還不一定能夠拼寫成功查近,如果改為:changeLanguage效果會好很多眉踱。

5、使用可搜索的名稱:

我建議大家在使用阿拉伯?dāng)?shù)字的時候霜威,最好能在代碼的最開始谈喳,使用大寫加下劃線定義。比如說50度是一個人體能夠承受的電力最大福特越界值戈泼,那么我們可以命名為:PEOPLE_MAX_VOLTA婿禽;當(dāng)然我英語能力有點不好,但是基本是這個原理大猛。如果單純的使用50的話扭倾,會讓人不知道這個是什么標(biāo)準,如果變成變量就容易閱讀挽绩。而且大家最好不要使用單個的英文字母膛壹,因為那樣會造成相當(dāng)大的麻煩,不僅僅是搜索唉堪,而且也難易理解模聋。

6、避免使用編碼:

不要使用一些前綴命名唠亚,比如說加一個m_之類的链方,這樣雖然可以多次命名,但是會讓人難以讀懂灶搜。

7祟蚀、避免思維映射:

避免單個名稱共啃,明確才是王道,不要以為你的單個名稱別人看不懂暂题,你就很牛逼移剪。如果代碼看起來像看小說一樣,那才叫牛逼薪者。

8纵苛、類名、方法名

類名應(yīng)當(dāng)是名詞言津、或者名詞短語攻人。例如:Customer、WikiPage悬槽,避免使用Maneger怀吻、Perocessor這類帶有動作的詞語;方法名初婆,盡量的能夠體現(xiàn)出這個方法的動作蓬坡,所以最好使用動詞,或者動詞短語磅叛,例如:postMail屑咳、deletePage,等等弊琴。

9兆龙、每個概念對應(yīng)一個詞:

給每個抽象概念選一個詞并且一以慣之,例如使用get敲董、方法紫皇,getMsg()、getUsername()腋寨、getUerId()等等聪铺。

10、不要使用雙關(guān)語:

避免同一個單詞用于不同的目的精置,比如說add這個就不是很好计寇,可以使用append這類詞語替換他。

11脂倦、添加語境:

就是給一些變量或者函數(shù)一些語境番宁,比如說:這段變量,firstName赖阻、lastName蝶押、street、state火欧,這些東西看起來我們都明白棋电,但是我們都不知道他是描述什么的茎截,如果加上address,改為;addressFirstName赶盔、addressLastName企锌、addressStreet、addressState于未,這樣的話就明朗很多了撕攒。

大家在對變量、函數(shù)烘浦、類命名的時候一定不要害怕他很長抖坪,只要能夠讀懂就好,當(dāng)然如果短能夠描述的清楚的話闷叉,還是必須得選擇短的擦俐,我是想說如果想描述清楚,不要害怕變量握侧、函數(shù)蚯瞧、類的命名太長。

來自:(51)[http://www.jb51.net/article/28002.htm]

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末藕咏,一起剝皮案震驚了整個濱河市状知,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌孽查,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,222評論 6 493
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件坦喘,死亡現(xiàn)場離奇詭異盲再,居然都是意外死亡,警方通過查閱死者的電腦和手機瓣铣,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,455評論 3 385
  • 文/潘曉璐 我一進店門答朋,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人棠笑,你說我怎么就攤上這事梦碗。” “怎么了蓖救?”我有些...
    開封第一講書人閱讀 157,720評論 0 348
  • 文/不壞的土叔 我叫張陵洪规,是天一觀的道長。 經(jīng)常有香客問我循捺,道長斩例,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,568評論 1 284
  • 正文 為了忘掉前任从橘,我火速辦了婚禮念赶,結(jié)果婚禮上础钠,老公的妹妹穿的比我還像新娘。我一直安慰自己叉谜,他們只是感情好旗吁,可當(dāng)我...
    茶點故事閱讀 65,696評論 6 386
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著停局,像睡著了一般很钓。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上翻具,一...
    開封第一講書人閱讀 49,879評論 1 290
  • 那天履怯,我揣著相機與錄音,去河邊找鬼裆泳。 笑死叹洲,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的工禾。 我是一名探鬼主播运提,決...
    沈念sama閱讀 39,028評論 3 409
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼闻葵!你這毒婦竟也來了民泵?” 一聲冷哼從身側(cè)響起声离,我...
    開封第一講書人閱讀 37,773評論 0 268
  • 序言:老撾萬榮一對情侶失蹤赁濒,失蹤者是張志新(化名)和其女友劉穎横殴,沒想到半個月后亩冬,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體斜友,經(jīng)...
    沈念sama閱讀 44,220評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡皿哨,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,550評論 2 327
  • 正文 我和宋清朗相戀三年滥比,在試婚紗的時候發(fā)現(xiàn)自己被綠了盗扇。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片早直。...
    茶點故事閱讀 38,697評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡寥假,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出霞扬,到底是詐尸還是另有隱情糕韧,我是刑警寧澤,帶...
    沈念sama閱讀 34,360評論 4 332
  • 正文 年R本政府宣布喻圃,位于F島的核電站萤彩,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏级及。R本人自食惡果不足惜乒疏,卻給世界環(huán)境...
    茶點故事閱讀 40,002評論 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望饮焦。 院中可真熱鬧怕吴,春花似錦窍侧、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,782評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至议经,卻和暖如春斧账,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背煞肾。 一陣腳步聲響...
    開封第一講書人閱讀 32,010評論 1 266
  • 我被黑心中介騙來泰國打工咧织, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人籍救。 一個月前我還...
    沈念sama閱讀 46,433評論 2 360
  • 正文 我出身青樓习绢,卻偏偏與公主長得像,于是被迫代替她去往敵國和親蝙昙。 傳聞我的和親對象是個殘疾皇子闪萄,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,587評論 2 350

推薦閱讀更多精彩內(nèi)容