title: "函數(shù)和方法命名規(guī)范"
date: 2015-11-01 19:27:00
tags: [Erica Sadun]
categories: [Swift 入門(mén)]
permalink: naming-methods-and-functions
原文鏈接=http://ericasadun.com/2015/08/31/naming-methods-and-functions/
作者=Erica Sadun
原文日期=2015/08/31
譯者=天才175
校對(duì)=numbbbbb
定稿=
發(fā)布時(shí)間=
請(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)和命名空間一樣普及，但是突然間就銷(xiāo)聲匿跡了。就像一百萬(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è)好例子。title: "函數(shù)和方法命名規(guī)范"
date: 2015-11-01 19:27:00
tags: [Erica Sadun]
categories: [Swift 入門(mén)]
permalink: naming-methods-and-functions
原文鏈接=http://ericasadun.com/2015/08/31/naming-methods-and-functions/
作者=Erica Sadun
原文日期=2015/08/31
譯者=天才175
校對(duì)=numbbbbb
定稿=
發(fā)布時(shí)間=
請(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)和命名空間一樣普及，但是突然間就銷(xiāo)聲匿跡了。就像一百萬(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è)好例子。
