命名的藝術(shù)

引言

我們?yōu)槭裁葱枰?guī)范命名?首先涛舍,容我舉個栗子:

有這樣一個求最大值的函數(shù):

//C
int max(int a, int b);
int zuidazhi(int a, int b);

讀第一行代碼的過程:單詞max->最大值
讀第二行代碼的過程:拼音zuidazhi->從拼音匹配對應(yīng)漢字->最大值
可能你現(xiàn)在還覺得第二種命名也不是那么難理解澄惊。那么再看看下面的:

//C
int checkUsername(char *username);
int jianchayonghuming(char *yonghuming);

如果你還覺得第二種命名簡單,不錯富雅,你的小學(xué)語文一定是滿分掸驱,可是你寫的程序其他人不一定能看懂,或者會花很多時間去看懂没佑。然后毕贼,國外的人一定都看不懂(黑人問號)。

為什么要談命名的藝術(shù)

  • 首先蛤奢,每個文件鬼癣,函數(shù)等都需要一個標(biāo)簽,為了我們能更快找到它們啤贩,命名就顯得比較重要了待秃。
  • 我們寫的代碼不光是給自己看的,你需要讓你的老師瓜晤,隊友锥余,甚至是上司都能看懂你的代碼。一個人只能耍耍小聰明痢掠,寫點小程序,而那些大型程序幾乎沒人能獨自完成嘲恍。團(tuán)隊合作時足画,命名就是看你是否坑隊友的標(biāo)準(zhǔn)之一。
  • 其實命名規(guī)則也是一種習(xí)慣佃牛,我們都遵循這個的規(guī)則淹辞,世界才能更加和平(x)。

通用的命名規(guī)則

  • 不要用拼音7馈O笞骸蔬将!
  • 不要作死去用關(guān)鍵字/保留字。
  • 常量大寫+下劃線命名法央星。

例子:

//Java
public class class {//這行直接炸
    public static final int EXIT_SUCCESS = 0;//下面應(yīng)該會有一個exit(EXIT_SUCCESS);吧霞怀,手動滑稽
    private int zonghe;//可以,這很拼音
}

Java命名規(guī)則

  • 據(jù)說Java支持中文變量莉给,但是中文不要來毙石。(據(jù)說有個叫e4a的就是這么干的)
  • 類名/文件名用帕斯卡命名法。<b>注:文件名必須和最外層public類類名相同</b>
  • 方法名/成員變量名/形參等用駝峰命名法颓遏。

例子:
文件名為TestClass.java

//Java
public class TestClass {//類名必須和文件名相同徐矩,帕斯卡命名法
    private int sum;
    public int getSum(){//駝峰
        return this.sum;
    }
}

更高級的姿勢

命名要有意義

  • for循環(huán)里的i,j,k什么的就不要說了
  • 類名:要能代表這個類的功能和類型(ChatClient)
  • 方法名:同樣要能表示方法的功能,還要簡單易懂(getServerIP)
  • 屬性1:一般是類名變駝峰命名叁幢,也可以將類名適當(dāng)縮寫(chatClient或client)
  • 屬性2:java源碼中經(jīng)常以m開頭來命名成員變量滤灯,雖然我不喜歡這么寫(mChatClient或mClient)
  • 盡量不要使用重復(fù)命名,這樣容易導(dǎo)致各種奇怪的問題曼玩。

其它命名規(guī)則(有點雜鳞骤,就不列舉多了)

  • 下劃線命名法。(腳本語言使用較多)
  • 特殊前后綴標(biāo)記(php的$演训,python的__)
#python
class Test:
    def __init__(self):
        self.name = None
def is_empty(content)://下劃線
    if content == "":
        return False
    else:
        return True

最后弟孟,再次強(qiáng)調(diào):不要用拼音!Q颉拂募!

最后的最后,貼上朱大的地址窟她,快去膜一波陈症。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市震糖,隨后出現(xiàn)的幾起案子录肯,更是在濱河造成了極大的恐慌,老刑警劉巖吊说,帶你破解...
    沈念sama閱讀 211,194評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件论咏,死亡現(xiàn)場離奇詭異,居然都是意外死亡颁井,警方通過查閱死者的電腦和手機(jī)厅贪,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,058評論 2 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來雅宾,“玉大人养涮,你說我怎么就攤上這事。” “怎么了贯吓?”我有些...
    開封第一講書人閱讀 156,780評論 0 346
  • 文/不壞的土叔 我叫張陵懈凹,是天一觀的道長。 經(jīng)常有香客問我悄谐,道長介评,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,388評論 1 283
  • 正文 為了忘掉前任尊沸,我火速辦了婚禮威沫,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘洼专。我一直安慰自己棒掠,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 65,430評論 5 384
  • 文/花漫 我一把揭開白布屁商。 她就那樣靜靜地躺著烟很,像睡著了一般。 火紅的嫁衣襯著肌膚如雪蜡镶。 梳的紋絲不亂的頭發(fā)上雾袱,一...
    開封第一講書人閱讀 49,764評論 1 290
  • 那天,我揣著相機(jī)與錄音官还,去河邊找鬼芹橡。 笑死,一個胖子當(dāng)著我的面吹牛望伦,可吹牛的內(nèi)容都是我干的林说。 我是一名探鬼主播,決...
    沈念sama閱讀 38,907評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼屯伞,長吁一口氣:“原來是場噩夢啊……” “哼腿箩!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起劣摇,我...
    開封第一講書人閱讀 37,679評論 0 266
  • 序言:老撾萬榮一對情侶失蹤珠移,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后末融,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體钧惧,經(jīng)...
    沈念sama閱讀 44,122評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,459評論 2 325
  • 正文 我和宋清朗相戀三年勾习,在試婚紗的時候發(fā)現(xiàn)自己被綠了垢乙。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,605評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡语卤,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情粹舵,我是刑警寧澤钮孵,帶...
    沈念sama閱讀 34,270評論 4 329
  • 正文 年R本政府宣布,位于F島的核電站眼滤,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜薪缆,卻給世界環(huán)境...
    茶點故事閱讀 39,867評論 3 312
  • 文/蒙蒙 一挽绩、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧堰塌,春花似錦赵刑、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,734評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至牵现,卻和暖如春铐懊,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背瞎疼。 一陣腳步聲響...
    開封第一講書人閱讀 31,961評論 1 265
  • 我被黑心中介騙來泰國打工科乎, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人贼急。 一個月前我還...
    沈念sama閱讀 46,297評論 2 360
  • 正文 我出身青樓茅茂,卻偏偏與公主長得像,于是被迫代替她去往敵國和親竿裂。 傳聞我的和親對象是個殘疾皇子玉吁,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,472評論 2 348

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