函數(shù)和方法命名規(guī)范

作者:Erica Sadun葵腹,原文鏈接垮庐,原文日期:2015-08-31
譯者:天才175爆袍;校對(duì):numbbbbb首繁;定稿:numbbbbb

請(qǐng)各位隨意批判作郭。同時(shí)請(qǐng)看這里這里

簡(jiǎn)單明了弦疮。根據(jù)上下文給動(dòng)詞和介詞加上名詞夹攒。請(qǐng)使用removeObject(object, atIndex: index),而不是remove(object, at: index)胁塞。不要為了過(guò)度的簡(jiǎn)潔而影響清晰準(zhǔn)確性芹助。

避免縮寫(xiě)。使用printError(myError)而不是printErr(myErr)以及setBackgroundImage(myImage)而不是setBGImage(myImg)闲先。雖然蘋(píng)果提供了一系列“可接受”的縮寫(xiě),但是請(qǐng)不要在 Swift 中使用像 max 和 min 這樣的縮寫(xiě)无蜂。

避免歧義伺糠。考慮一下函數(shù)或者方法的命名是否存在多種解釋斥季。舉個(gè)栗子训桶,在displayName中,display 是名詞還是動(dòng)詞呢酣倾?如果命名不清晰的話舵揭,請(qǐng)重新命名來(lái)消除混淆。

保持一致性躁锡。在你的應(yīng)用和庫(kù)中使用相同的術(shù)語(yǔ)來(lái)描述概念午绳。避免在一個(gè)方法里使用fetchBezierElements(),卻在另外一個(gè)里使用listPathComponents()映之。

不要引用類型關(guān)鍵字拦焚。避免命名中出現(xiàn) struct、enum杠输、class赎败、instance 以及 object。請(qǐng)使用buildDeckofCards()而不是buildDeckofCardsStruct()蠢甲。

方法命名使用小寫(xiě)僵刮。雖然大多數(shù)開(kāi)發(fā)者使用小寫(xiě)命名全局函數(shù),但你可以大寫(xiě)鹦牛,這并不是什么罪過(guò)搞糕。雖然這種函數(shù)命名過(guò)時(shí)了,但大寫(xiě)的函數(shù)名卻能立刻將函數(shù)與方法區(qū)別開(kāi)來(lái)能岩。有一段時(shí)間我也改變過(guò)想法寞宫,但是最終還是決定奮起抗?fàn)帲褂眯?xiě)拉鹃。這種做法曾經(jīng)和命名空間一樣普及辈赋,但是突然間就銷聲匿跡了鲫忍。就像一百萬(wàn)個(gè)喊著大寫(xiě)的人突然沉默。

省略"get"钥屈。獲取狀態(tài)信息的函數(shù)應(yīng)該描述他們要返回的東西悟民。請(qǐng)使用extendedExecutionIsEnabled()isExtendedExecutionEnabled()而不是getExtendedExecutionIsEnabled()。通過(guò)參數(shù)返回?cái)?shù)據(jù)的函數(shù)例外篷就。

使用標(biāo)簽描述參數(shù)射亏。建議結(jié)合函數(shù)名和標(biāo)簽來(lái)描述函數(shù)本身,這樣創(chuàng)建出來(lái)的會(huì)是包括介詞(with竭业、of智润、between 等等)的描述符。你會(huì)"construct color with red, green, and blue"(譯者注:使用紅綠藍(lán)構(gòu)建顏色)未辆,測(cè)試"length of string"(譯者注:字符串的長(zhǎng)度)窟绷,或者"test equality between x and y"(譯者注:判斷 x 和 y 是否相等)。

好的函數(shù)名和標(biāo)簽可以告訴人們?nèi)绾问褂煤瘮?shù)咐柜。結(jié)果會(huì)是自文檔化兼蜈,不用依靠記憶或查找來(lái)確定需要傳入的參數(shù)。請(qǐng)使用withTag:而不是tag:拙友。

使用介詞为狸,避免"and"And 是 Apple 特別聲稱要避免的一個(gè)詞遗契。避免使用"view and position"辐棒,使用"view, position"。

如果你必須使用and牍蜂,請(qǐng)確保一組參數(shù)有語(yǔ)義聯(lián)系涉瘾,如使用"red, green and blue"構(gòu)建顏色。哪怕之后調(diào)整了關(guān)鍵字捷兰,也顯然不可能中斷這些項(xiàng)的聯(lián)系立叛。在這種情況下,即使是代碼潔癖患者也不會(huì)認(rèn)為你的代碼有問(wèn)題贡茅。

Apple 支持使用 and 的一個(gè)例子是在一個(gè)方法中描述兩種截然不同的動(dòng)作秘蛇,比如openFile(withApplication:, andDeactivate:)

**在基于類型的名字后面加上value **顶考。請(qǐng)使用toIntValue而不是toInt赁还,以及withCGRectValue而不是withCGRect

使用美國(guó)標(biāo)準(zhǔn)短語(yǔ)驹沿。由于這些詞是由 Apple 提供的艘策,請(qǐng)使用 initialize 而不是 initialise 以及 color 而不是 colour。

有疑惑渊季,找 Apple朋蔫。使用相似的概念搜索 Apple API 接口并模仿其方法簽名罚渐。盡量參考 Objective-C 命名,因?yàn)?Swift 中的 Apple API 并沒(méi)有全部通過(guò)人工審查驯妄。自動(dòng)轉(zhuǎn)換過(guò)來(lái)的 API 可能并不是一個(gè)好例子荷并。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市青扔,隨后出現(xiàn)的幾起案子源织,更是在濱河造成了極大的恐慌,老刑警劉巖微猖,帶你破解...
    沈念sama閱讀 217,734評(píng)論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件谈息,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡凛剥,警方通過(guò)查閱死者的電腦和手機(jī)黎茎,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,931評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)当悔,“玉大人,你說(shuō)我怎么就攤上這事踢代∶ぴ鳎” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 164,133評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵胳挎,是天一觀的道長(zhǎng)饼疙。 經(jīng)常有香客問(wèn)我,道長(zhǎng)慕爬,這世上最難降的妖魔是什么窑眯? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,532評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮医窿,結(jié)果婚禮上磅甩,老公的妹妹穿的比我還像新娘。我一直安慰自己姥卢,他們只是感情好卷要,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,585評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著独榴,像睡著了一般僧叉。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上棺榔,一...
    開(kāi)封第一講書(shū)人閱讀 51,462評(píng)論 1 302
  • 那天瓶堕,我揣著相機(jī)與錄音,去河邊找鬼症歇。 笑死郎笆,一個(gè)胖子當(dāng)著我的面吹牛谭梗,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播题画,決...
    沈念sama閱讀 40,262評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼默辨,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了苍息?” 一聲冷哼從身側(cè)響起缩幸,我...
    開(kāi)封第一講書(shū)人閱讀 39,153評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎竞思,沒(méi)想到半個(gè)月后表谊,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,587評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡盖喷,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,792評(píng)論 3 336
  • 正文 我和宋清朗相戀三年爆办,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片课梳。...
    茶點(diǎn)故事閱讀 39,919評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡距辆,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出暮刃,到底是詐尸還是另有隱情跨算,我是刑警寧澤,帶...
    沈念sama閱讀 35,635評(píng)論 5 345
  • 正文 年R本政府宣布椭懊,位于F島的核電站诸蚕,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏氧猬。R本人自食惡果不足惜背犯,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,237評(píng)論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望盅抚。 院中可真熱鬧漠魏,春花似錦、人聲如沸妄均。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,855評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)丛晦。三九已至奕纫,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間烫沙,已是汗流浹背匹层。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,983評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人升筏。 一個(gè)月前我還...
    沈念sama閱讀 48,048評(píng)論 3 370
  • 正文 我出身青樓撑柔,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親您访。 傳聞我的和親對(duì)象是個(gè)殘疾皇子铅忿,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,864評(píng)論 2 354

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