1. 代碼格式
1.1 使用四個(gè)空格進(jìn)行縮進(jìn)赃梧。
1.2 每行最多160個(gè)字符议薪，這樣可以避免一行過長(zhǎng)省店。 (Xcode->Preferences->Text Editing->Page guide at column: 設(shè)置成160即可)
1.3 確保每個(gè)文件結(jié)尾都有空白行。
1.4 確保每行都不以空白字符作為結(jié)尾 （Xcode->Preferences->Text Editing->Automatically trim trailing whitespace + Including whitespace-only lines).
1.5 左大括號(hào)不用另起一行浅辙。
class SomeClass {
func someMethod() {
if x == y {
/* ... */
} else if x == z {
/* ... */
} else {
/* ... */
}
}
/* ... */
}
1.6 當(dāng)在寫一個(gè)變量類型谢揪，一個(gè)字典里的主鍵蕉陋，一個(gè)函數(shù)的參數(shù)，遵從一個(gè)協(xié)議拨扶，或一個(gè)父類凳鬓，不用在分號(hào)前添加空格。
// 指定類型
let pirateViewController: PirateViewController
// 字典語法(注意這里是向左對(duì)齊而不是分號(hào)對(duì)齊)
let ninjaDictionary: [String: AnyObject] = [
"fightLikeDairyFarmer": false,
"disgusting": true
]
// 聲明函數(shù)
func myFunction<t, u: someprotocol where t.relatedtype == u>(firstArgument: U, secondArgument: T) {
/* ... */
}
// 調(diào)用函數(shù)
someFunction(someArgument: "Kitten")
// 父類
class PirateViewController: UIViewController {
/* ... */
}
// 協(xié)議
extension PirateViewController: UITableViewDataSource {
/* ... */
}</t, u: someprotocol where t.relatedtype == u>
1.7 基本來說患民，要在逗號(hào)后面加空格缩举。
let myArray = [1, 2, 3, 4, 5]
1.8 二元運(yùn)算符(+, ==, 或->)的前后都需要添加空格，左小括號(hào)后面和右小括號(hào)前面不需要空格匹颤。
let myValue = 20 + (30 / 2) * 3
if 1 + 1 == 3 {
fatalError("The universe is broken.")
}
func pancake() -> Pancake {
/* ... */
}
1.9 遵守Xcode內(nèi)置的縮進(jìn)格式( 如果已經(jīng)遵守蚁孔，按下CTRL-i 組合鍵文件格式?jīng)]有變化)。當(dāng)聲明的一個(gè)函數(shù)需要跨多行時(shí)惋嚎，推薦使用Xcode默認(rèn)的格式，目前Xcode 版本是 7.3站刑。
// Xcode針對(duì)跨多行函數(shù)聲明縮進(jìn)
func myFunctionWithManyParameters(parameterOne: String,
parameterTwo: String,
parameterThree: String) {
// Xcode會(huì)自動(dòng)縮進(jìn)
print("\(parameterOne) \(parameterTwo) \(parameterThree)")
}
// Xcode針對(duì)多行 if 語句的縮進(jìn)
if myFirstVariable > (mySecondVariable + myThirdVariable)
&& myFourthVariable == .SomeEnumValue {
// Xcode會(huì)自動(dòng)縮進(jìn)
print("Hello, World!")
}
1.10 當(dāng)調(diào)用的函數(shù)有多個(gè)參數(shù)時(shí)另伍，每一個(gè)參數(shù)另起一行，并比函數(shù)名多一個(gè)縮進(jìn)绞旅。
someFunctionWithManyArguments(
firstArgument: "Hello, I am a string",
secondArgument: resultFromSomeFunction()
thirdArgument: someOtherLocalVariable)
1.11 當(dāng)遇到需要處理的數(shù)組或字典內(nèi)容較多需要多行顯示時(shí)摆尝，需把 [ 和 ] 類似于方法體里的括號(hào)， 方法體里的閉包也要做類似處理因悲。
someFunctionWithABunchOfArguments(
someStringArgument: "hello I am a string",
someArrayArgument: [
"dadada daaaa daaaa dadada daaaa daaaa dadada daaaa daaaa",
"string one is crazy - what is it thinking?"
],
someDictionaryArgument: [
"dictionary key 1": "some value 1, but also some more text here",
"dictionary key 2": "some value 2"
],
someClosure: { parameter1 in
print(parameter1)
})
1.12 應(yīng)盡量避免出現(xiàn)多行斷言堕汞，可使用本地變量或其他策略。
// 推薦
let firstCondition = x == firstReallyReallyLongPredicateFunction()
let secondCondition = y == secondReallyReallyLongPredicateFunction()
let thirdCondition = z == thirdReallyReallyLongPredicateFunction()
if firstCondition && secondCondition && thirdCondition {
// 你要干什么
}
// 不推薦
if x == firstReallyReallyLongPredicateFunction()
&& y == secondReallyReallyLongPredicateFunction()
&& z == thirdReallyReallyLongPredicateFunction() {
// 你要干什么
}
2. 命名
2.1 在Swift中不用如Objective-C式 一樣添加前綴 (如使用 GuybrushThreepwoode 而不是 LIGuybrushThreepwood)晃琳。
2.2 使用帕斯卡拼寫法（又名大駱駝拼寫法讯检，首字母大寫）為類型命名 (如 struct, enum, class, typedef, associatedtype 等)琐鲁。
2.3 使用小駱駝拼寫法 (首字母小寫) 為函數(shù)，方法人灼，變量围段，常量，參數(shù)等命名投放。
2.4 首字母縮略詞在命名中一般來說都是全部大寫奈泪，例外的情形是如果首字母縮略詞是一個(gè)命名的開始部分，而這個(gè)命名需要小寫字母作為開頭灸芳，這種情形下首字母縮略詞全部小寫涝桅。
// "HTML" 是變量名的開頭, 需要全部小寫 "html"
let htmlBodyContent: String = "<p>Hello, World!</p>"
// 推薦使用 ID 而不是 Id
let profileID: Int = 1
// 推薦使用 URLFinder 而不是 UrlFinder
class URLFinder {
/* ... */
}
2.5 使用前綴 k + 大駱駝命名法 為所有非單例的靜態(tài)常量命名。
class MyClassName {
// 基元常量使用 k 作為前綴
static let kSomeConstantHeight: CGFloat = 80.0
// 非基元常量也是用 k 作為前綴
static let kDeleteButtonColor = UIColor.redColor()
// 對(duì)于單例不要使用k作為前綴
static let sharedInstance = MyClassName()
/* ... */
}
2.6 對(duì)于泛型和關(guān)聯(lián)類型烙样，可以使用單個(gè)大寫字母冯遂，也可是遵從大駱駝命名方式并能描述泛型的單詞。如果這個(gè)單詞和要實(shí)現(xiàn)的協(xié)議或繼承的父類有沖突误阻，可以為相關(guān)類型或泛型名字添加 Type 作為后綴债蜜。
class SomeClass<t> { /* ... */ }
class SomeClass<model> { /* ... */ }
protocol Modelable {
associatedtype Model
}
protocol Sequence {
associatedtype IteratorType: Iterator
}</model></t>
2.7 命名應(yīng)該具有描述性 和 清晰的。
// 推薦
class RoundAnimatingButton: UIButton { /* ... */ }
// 不推薦
class CustomButton: UIButton { /* ... */ }
2.8 不要縮寫究反，簡(jiǎn)寫命名寻定，或用單個(gè)字母命名。
// 推薦
class RoundAnimatingButton: UIButton {
let animationDuration: NSTimeInterval
func startAnimating() {
let firstSubview = subviews.first
}
}
// 不推薦
class RoundAnimating: UIButton {
let aniDur: NSTimeInterval
func srtAnmating() {
let v = subviews.first
}
}
2.9 如果原有命名不能明顯表明類型精耐，則屬性命名內(nèi)要包括類型信息狼速。
// 推薦
class ConnectionTableViewCell: UITableViewCell {
let personImageView: UIImageView
let animationDuration: NSTimeInterval
// 作為屬性名的firstName，很明顯是字符串類型卦停，所以不用在命名里不用包含String
let firstName: String
// 雖然不推薦, 這里用 Controller 代替 ViewController 也可以向胡。
let popupController: UIViewController
let popupViewController: UIViewController
// 如果需要使用UIViewController的子類，如TableViewController, CollectionViewController, SplitViewController, 等惊完，需要在命名里標(biāo)名類型僵芹。
let popupTableViewController: UITableViewController
// 當(dāng)使用outlets時(shí), 確保命名中標(biāo)注類型。
@IBOutlet weak var submitButton: UIButton!
@IBOutlet weak var emailTextField: UITextField!
@IBOutlet weak var nameLabel: UILabel!
}
// 不推薦
class ConnectionTableViewCell: UITableViewCell {
// 這個(gè)不是 UIImage, 不應(yīng)該以Image 為結(jié)尾命名小槐。
// 建議使用 personImageView
let personImage: UIImageView
// 這個(gè)不是String拇派，應(yīng)該命名為 textLabel
let text: UILabel
// animation 不能清晰表達(dá)出時(shí)間間隔
// 建議使用 animationDuration 或 animationTimeInterval
let animation: NSTimeInterval
// transition 不能清晰表達(dá)出是String
// 建議使用 transitionText 或 transitionString
let transition: String
// 這個(gè)是ViewController，不是View
let popupView: UIViewController
// 由于不建議使用縮寫凿跳，這里建議使用 ViewController替換 VC
let popupVC: UIViewController
// 技術(shù)上講這個(gè)變量是 UIViewController, 但應(yīng)該表達(dá)出這個(gè)變量是TableViewController
let popupViewController: UITableViewController
// 為了保持一致性件豌，建議把類型放到變量的結(jié)尾，而不是開始控嗜，如submitButton
@IBOutlet weak var btnSubmit: UIButton!
@IBOutlet weak var buttonSubmit: UIButton!
// 在使用outlets 時(shí)茧彤，變量名內(nèi)應(yīng)包含類型名。
// 這里建議使用 firstNameLabel
@IBOutlet weak var firstName: UILabel!
}
2.10 當(dāng)給函數(shù)參數(shù)命名時(shí)疆栏，要確保函數(shù)能理解每個(gè)參數(shù)的目的曾掂。
2.11 根據(jù)蘋果接口設(shè)計(jì)指導(dǎo)文檔, 如果協(xié)議描述的是協(xié)議做的事應(yīng)該命名為名詞(如Collection) 惫谤，如果描述的是行為，需添加后綴 able 或 ing (如Equatable 和 ProgressReporting)遭殉。 如果上述兩者都不能滿足需求石挂，可以添加Protocol作為后綴，例子見下面险污。
// 這個(gè)協(xié)議描述的是協(xié)議能做的事痹愚，應(yīng)該命名為名詞。
protocol TableViewSectionProvider {
func rowHeight(atRow row: Int) -> CGFloat
var numberOfRows: Int { get }
/* ... */
}
// 這個(gè)協(xié)議表達(dá)的是行為, 以able最為后綴
protocol Loggable {
func logCurrentState()
/* ... */
}
// 因?yàn)橐呀?jīng)定義類InputTextView蛔糯，如果依然需要定義相關(guān)協(xié)議拯腮，可以添加 Protocol作為后綴。
protocol InputTextViewProtocol {
func sendTrackingEvent()
func inputText() -> String
/* ... */
}
3. 代碼風(fēng)格
3.1 綜合
3.1.1 盡可能的多使用let蚁飒，少使用var动壤。
3.1.2 當(dāng)需要遍歷一個(gè)集合并變形成另一個(gè)集合時(shí)，推薦使用函數(shù) map, filter 和 reduce淮逻。
// 推薦
let stringOfInts = [1, 2, 3].flatMap { String($0) }
// ["1", "2", "3"]
// 不推薦
var stringOfInts: [String] = []
for integer in [1, 2, 3] {
stringOfInts.append(String(integer))
}
// 推薦
let evenNumbers = [4, 8, 15, 16, 23, 42].filter { $0 % 2 == 0 }
// [4, 8, 16, 42]
// 不推薦
var evenNumbers: [Int] = []
for integer in [4, 8, 15, 16, 23, 42] {
if integer % 2 == 0 {
evenNumbers(integer)
}
}
3.1.3 如果變量類型可以依靠推斷得出琼懊，不建議聲明變量時(shí)指明類型。
3.1.4 如果一個(gè)函數(shù)有多個(gè)返回值爬早，推薦使用 元組 而不是 inout 參數(shù)哼丈， 如果你見到一個(gè)元組多次，建議使用typealias 筛严，而如果返回的元組有三個(gè)或多于三個(gè)以上的元素醉旦，建議使用結(jié)構(gòu)體或類。
func pirateName() -> (firstName: String, lastName: String) {
return ("Guybrush", "Threepwood")
}
let name = pirateName()
let firstName = name.firstName
let lastName = name.lastName
3.1.5 當(dāng)使用委托和協(xié)議時(shí)桨啃，請(qǐng)注意避免出現(xiàn)循環(huán)引用车胡，基本上是在定義屬性的時(shí)候使用 weak 修飾。
3.1.6 在閉包里使用 self 的時(shí)候要注意出現(xiàn)循環(huán)引用照瘾，使用捕獲列表可以避免這一點(diǎn)匈棘。
myFunctionWithClosure() { [weak self] (error) -> Void in
// 方案 1
self?.doSomething()
// 或方案 2
guard let strongSelf = self else {
return
}
strongSelf.doSomething()
}
3.1.7 Switch 模塊中不用顯式使用break。
3.1.8 斷言流程控制的時(shí)候不要使用小括號(hào)析命。
// 推薦
if x == y {
/* ... */
}
// 不推薦
if (x == y) {
/* ... */
}
3.1.9 在寫枚舉類型的時(shí)候主卫，盡量簡(jiǎn)寫。
// 推薦
imageView.setImageWithURL(url, type: .person)
// 不推薦
imageView.setImageWithURL(url, type: AsyncImageView.Type.person)
3.1.10 在使用類方法的時(shí)候不用簡(jiǎn)寫碳却，因?yàn)轭惙椒ú蝗?枚舉 類型一樣，可以根據(jù)輕易地推導(dǎo)出上下文笑旺。
// 推薦
imageView.backgroundColor = UIColor.whiteColor()
// 不推薦
imageView.backgroundColor = .whiteColor()
3.1.11 不建議使用用self.修飾除非需要昼浦。
3.1.12 在新寫一個(gè)方法的時(shí)候，需要衡量這個(gè)方法是否將來會(huì)被重寫筒主，如果不是关噪，請(qǐng)用 final 關(guān)鍵詞修飾鸟蟹，這樣阻止方法被重寫。一般來說使兔，final 方法可以優(yōu)化編譯速度建钥，在合適的時(shí)候可以大膽使用它。但需要注意的是虐沥，在一個(gè)公開發(fā)布的代碼庫(kù)中使用 final 和本地項(xiàng)目中使用 final 的影響差別很大的熊经。
3.1.13 在使用一些語句如 else，catch等緊隨代碼塊的關(guān)鍵詞的時(shí)候欲险，確保代碼塊和關(guān)鍵詞在同一行镐依。下面 if/else 和 do/catch 的例子.
if someBoolean {
// 你想要什么
} else {
// 你不想做什么
}
do {
let fileContents = try readFile("filename.txt")
} catch {
print(error)
}
3.2 訪問控制修飾符
3.2.1 如果需要把訪問修飾符放到第一個(gè)位置。
// 推薦
private static let kMyPrivateNumber: Int
// 不推薦
static private let kMyPrivateNumber: Int
3.2.2 訪問修飾符不應(yīng)單獨(dú)另起一行天试，應(yīng)和訪問修飾符描述的對(duì)象保持在同一行槐壳。
// 推薦
public class Pirate {
/* ... */
}
// 不推薦
public
class Pirate {
/* ... */
}
3.2.3 默認(rèn)的訪問控制修飾符是 internal, 如果需要使用internal 可以省略不寫。
3.2.4 當(dāng)一個(gè)變量需要被單元測(cè)試 訪問時(shí)喜每，需要聲明為 internal 類型來使用@testable import {ModuleName}务唐。 如果一個(gè)變量實(shí)際上是private 類型，而因?yàn)閱卧獪y(cè)試需要被聲明為 internal 類型带兜，確定添加合適的注釋文檔來解釋為什么這么做枫笛。這里添加注釋推薦使用 - warning: 標(biāo)記語法。
/**
這個(gè)變量是private 名字
- warning: 定義為 internal 而不是 private 為了 `@testable`.
*/
let pirateName = "LeChuck"
3.3 自定義操作符
不推薦使用自定義操作符鞋真，如果需要?jiǎng)?chuàng)建函數(shù)來替代崇堰。
在重寫操作符之前，請(qǐng)慎重考慮是否有充分的理由一定要在全局范圍內(nèi)創(chuàng)建新的操作符涩咖，而不是使用其他策略海诲。
你可以重載現(xiàn)有的操作符來支持新的類型(特別是 ==)，但是新定義的必須保留操作符的原來含義檩互，比如 == 必須用來測(cè)試是否相等并返回布爾值特幔。
3.4 Switch 語句 和 枚舉
3.4.1 在使用 Switch 語句時(shí)，如果選項(xiàng)是有限集合時(shí)闸昨，不要使用default蚯斯，相反地，把一些不用的選項(xiàng)放到底部饵较，并用 break 關(guān)鍵詞 阻止其執(zhí)行拍嵌。
3.4.2 因?yàn)镾wift 中的 switch 選項(xiàng)默認(rèn)是包含break的， 如果不需要不用使用 break 關(guān)鍵詞循诉。
3.4.3 case 語句 應(yīng)和 switch 語句左對(duì)齊横辆，并在 標(biāo)準(zhǔn)的 default 上面。
3.4.4 當(dāng)定義的選項(xiàng)有關(guān)聯(lián)值時(shí)茄猫，確保關(guān)聯(lián)值有恰當(dāng)?shù)拿Q狈蚤，而不只是類型困肩。(如. 使用 case Hunger(hungerLevel: Int) 而不是 case Hunger(Int)).
enum Problem {
case attitude
case hair
case hunger(hungerLevel: Int)
}
func handleProblem(problem: Problem) {
switch problem {
case .attitude:
print("At least I don't have a hair problem.")
case .hair:
print("Your barber didn't know when to stop.")
case .hunger(let hungerLevel):
print("The hunger level is \(hungerLevel).")
}
}
3.4.5 推薦盡可能使用fall through。
3.4.6 如果default 的選項(xiàng)不應(yīng)該觸發(fā)脆侮，可以拋出錯(cuò)誤 或 斷言類似的做法锌畸。
func handleDigit(digit: Int) throws {
case 0, 1, 2, 3, 4, 5, 6, 7, 8, 9:
print("Yes, \(digit) is a digit!")
default:
throw Error(message: "The given number was not a digit.")
}
3.5 可選類型
3.5.1 唯一使用隱式拆包可選型（implicitly unwrapped optionals）的場(chǎng)景是結(jié)合@IBOutlets，在其他場(chǎng)景使用 非可選類型 和 常規(guī)可選類型靖避，即使有的場(chǎng)景你確定有的變量使用的時(shí)候永遠(yuǎn)不會(huì)為 nil潭枣， 但這樣做可以保持一致性和程序更加健壯。
3.5.2 不要使用 as! 或 try!筋蓖。
3.5.3 如果對(duì)于一個(gè)變量你不打算聲明為可選類型卸耘，但當(dāng)需要檢查變量值是否為 nil，推薦用當(dāng)前值和 nil 直接比較粘咖，而不推薦使用 if let 語法蚣抗。
// 推薦
if someOptional != nil {
// 你要做什么
}
// 不推薦
if let _ = someOptional {
// 你要做什么
}
3.5.4 不要使用 unowned，unowned 和 weak 變量基本上等價(jià)瓮下，并且都是隱式拆包( unowned 在引用計(jì)數(shù)上有少許性能優(yōu)化)翰铡，由于不推薦使用隱式拆包，也不推薦使用unowned 變量讽坏。
// 推薦
weak var parentViewController: UIViewController?
// 不推薦
weak var parentViewController: UIViewController!
unowned var parentViewController: UIViewController
3.5.5 當(dāng)拆包取值時(shí)锭魔，使用和被拆包取值變量相同的名稱。
guard let myVariable = myVariable else {
return
}
3.6 協(xié)議
在實(shí)現(xiàn)協(xié)議的時(shí)候路呜，有兩種方式來組織你的代碼:
使用 // MARK: 注釋來分割協(xié)議實(shí)現(xiàn)和其他代碼迷捧。
使用 extension 在 類/結(jié)構(gòu)體已有代碼外，但在同一個(gè)文件內(nèi)胀葱。
請(qǐng)注意 extension 內(nèi)的代碼不能被子類重寫漠秋，這也意味著測(cè)試很難進(jìn)行。 如果這是經(jīng)常發(fā)生的情況抵屿，為了代碼一致性最好統(tǒng)一使用第一種辦法庆锦。否則使用第二種辦法，其可以代碼分割更清晰轧葛。
使用而第二種方法的時(shí)候搂抒，使用 // MARK: 依然可以讓代碼在 Xcode 可讀性更強(qiáng)。
3.7 屬性
3.7.1 對(duì)于只讀屬性尿扯，計(jì)算后(Computed)屬性, 提供 getter 而不是 get {}求晶。
var computedProperty: String {
if someBool {
return "I'm a mighty pirate!"
}
return "I'm selling these fine leather jackets."
}
3.7.2 對(duì)于屬性相關(guān)方法 get {}, set {}, willSet, 和 didSet, 確保縮進(jìn)相關(guān)代碼塊衷笋。
3.7.3 對(duì)于willSet/didSet 和 set 中的舊值和新值雖然可以自定義名稱芳杏，但推薦使用默認(rèn)標(biāo)準(zhǔn)名稱 newValue/oldValue。
var computedProperty: String {
get {
if someBool {
return "I'm a mighty pirate!"
}
return "I'm selling these fine leather jackets."
}
set {
computedProperty = newValue
}
willSet {
print("will set to \(newValue)")
}
didSet {
print("did set from \(oldValue) to \(newValue)")
}
}
3.7.4 在創(chuàng)建類常量的時(shí)候，使用 static 關(guān)鍵詞修飾蚜锨。
class MyTableViewCell: UITableViewCell {
static let kReuseIdentifier = String(MyTableViewCell)
static let kCellHeight: CGFloat = 80.0
}
3.7.5 聲明單例屬性可以通過下面方式進(jìn)行：
class PirateManager {
static let sharedInstance = PirateManager()
/* ... */
}
3.8 閉包
3.8.1 如果參數(shù)的類型很明顯，可以在函數(shù)名里可以省略參數(shù)類型, 但明確聲明類型也是允許的慢蜓。 代碼的可讀性有時(shí)候是添加詳細(xì)的信息亚再，而有時(shí)候部分重復(fù)，根據(jù)你的判斷力做出選擇吧晨抡，但前后要保持一致性氛悬。
// 省略類型
doSomethingWithClosure() { response in
print(response)
}
// 明確指出類型
doSomethingWithClosure() { response: NSURLResponse in
print(response)
}
// map 語句使用簡(jiǎn)寫
[1, 2, 3].flatMap { String($0) }
3.8.2 如果使用捕捉列表 或 有具體的非 Void返回類型，參數(shù)列表應(yīng)該在小括號(hào)內(nèi)耘柱， 否則小括號(hào)可以省略如捅。
// 因?yàn)槭褂貌蹲搅斜恚±ㄌ?hào)不能省略调煎。
doSomethingWithClosure() { [weak self] (response: NSURLResponse) in
self?.handleResponse(response)
}
// 因?yàn)榉祷仡愋途登玻±ㄌ?hào)不能省略。
doSomethingWithClosure() { (response: NSURLResponse) -> String in
return String(response)
}
3.8.3 如果閉包是變量類型士袄，不需把變量值放在括號(hào)中悲关，除非需要，如變量類型是可選類型(Optional?)娄柳， 或當(dāng)前閉包在另一個(gè)閉包內(nèi)寓辱。確保閉包里的所以參數(shù)放在小括號(hào)中，這樣()表示沒有參數(shù)赤拒，Void 表示不需要返回值秫筏。
let completionBlock: (success: Bool) -> Void = {
print("Success? \(success)")
}
let completionBlock: () -> Void = {
print("Completed!")
}
let completionBlock: (() -> Void)? = nil
3.9 數(shù)組
3.9.1 基本上不要通過下標(biāo)直接訪問數(shù)組內(nèi)容，如果可能使用如 .first 或 .last, 因?yàn)檫@些方法是非強(qiáng)制類型并不會(huì)崩潰挎挖。 推薦盡可能使用 for item in items 而不是 for i in 0..
3.9.2 不要使用 += 或 + 操作符給數(shù)組添加新元素这敬，使用性能較好的.append() 或.appendContentsOf() ，如果需要聲明數(shù)組基于其他的數(shù)組并保持不可變類型肋乍， 使用 let myNewArray = [arr1, arr2].flatten()鹅颊，而不是let myNewArray = arr1 + arr2 。
3.10 錯(cuò)誤處理
假設(shè)一個(gè)函數(shù) myFunction 返回類型聲明為 String墓造，但是總有可能函數(shù)會(huì)遇到error堪伍，有一種解決方案是返回類型聲明為 String?, 當(dāng)遇到錯(cuò)誤的時(shí)候返回 nil。
例子:
func readFile(withFilename filename: String) -> String? {
guard let file = openFile(filename) else {
return nil
}
let fileContents = file.read()
file.close()
return fileContents
}
func printSomeFile() {
let filename = "somefile.txt"
guard let fileContents = readFile(filename) else {
print("不能打開 \(filename).")
return
}
print(fileContents)
}
實(shí)際上如果預(yù)知失敗的原因觅闽，我們應(yīng)該使用Swift 中的 try/catch 帝雇。
定義 錯(cuò)誤對(duì)象 結(jié)構(gòu)體如下:
struct Error: ErrorType {
public let file: StaticString
public let function: StaticString
public let line: UInt
public let message: String
public init(message: String, file: StaticString = #file, function: StaticString = #function, line: UInt = #line) {
self.file = file
self.function = function
self.line = line
self.message = message
}
}
使用案例:
func readFile(withFilename filename: String) throws -> String {
guard let file = openFile(filename) else {
throw Error(message: “打不開的文件名稱 \(filename).")
}
let fileContents = file.read()
file.close()
return fileContents
}
func printSomeFile() {
do {
let fileContents = try readFile(filename)
print(fileContents)
} catch {
print(error)
}
}
其實(shí)項(xiàng)目中還是有一些場(chǎng)景更適合聲明為可選類型，而不是錯(cuò)誤捕捉和處理蛉拙，比如在獲取遠(yuǎn)端數(shù)據(jù)過程中遇到錯(cuò)誤尸闸，nil作為返回結(jié)果是合理的，也就是聲明返回可選類型比錯(cuò)誤處理更合理。
整體上說吮廉，如果一個(gè)方法有可能失敗苞尝，并且使用可選類型作為返回類型會(huì)導(dǎo)致錯(cuò)誤原因湮沒，不妨考慮拋出錯(cuò)誤而不是吃掉它宦芦。
3.11 使用 guard 語句
3.11.1 總體上宙址，我們推薦使用提前返回的策略，而不是 if 語句的嵌套调卑。使用 guard 語句可以改善代碼的可讀性抡砂。
// 推薦
func eatDoughnut(atIndex index: Int) {
guard index >= 0 && index < doughnuts else {
// 如果 index 超出允許范圍，提前返回恬涧。
return
}
let doughnut = doughnuts[index]
eat(doughnut)
}
// 不推薦
func eatDoughnuts(atIndex index: Int) {
if index >= 0 && index < donuts.count {
let doughnut = doughnuts[index]
eat(doughnut)
}
}
3.11.2 在解析可選類型時(shí)注益，推薦使用 guard 語句，而不是 if 語句溯捆，因?yàn)?guard 語句可以減少不必要的嵌套縮進(jìn)丑搔。
// 推薦
guard let monkeyIsland = monkeyIsland else {
return
}
bookVacation(onIsland: monkeyIsland)
bragAboutVacation(onIsland: monkeyIsland)
// 不推薦
if let monkeyIsland = monkeyIsland {
bookVacation(onIsland: monkeyIsland)
bragAboutVacation(onIsland: monkeyIsland)
}
// 禁止
if monkeyIsland == nil {
return
}
bookVacation(onIsland: monkeyIsland!)
bragAboutVacation(onIsland: monkeyIsland!)
3.11.3 當(dāng)解析可選類型需要決定在 if 語句 和 guard 語句之間做選擇時(shí)，最重要的判斷標(biāo)準(zhǔn)是是否讓代碼可讀性更強(qiáng)提揍，實(shí)際項(xiàng)目中會(huì)面臨更多的情景低匙，如依賴 2 個(gè)不同的布爾值，復(fù)雜的邏輯語句會(huì)涉及多次比較等碳锈，大體上說顽冶，根據(jù)你的判斷力讓代碼保持一致性和更強(qiáng)可讀性， 如果你不確定 if 語句 和 guard 語句哪一個(gè)可讀性更強(qiáng)售碳，建議使用 guard 强重。
// if 語句更有可讀性
if operationFailed {
return
}
// guard 語句這里有更好的可讀性
guard isSuccessful else {
return
}
// 雙重否定不易被理解 - 不要這么做
guard !operationFailed else {
return
}
3.11.4 如果需要在2個(gè)狀態(tài)間做出選擇，建議使用if 語句贸人，而不是使用 guard 語句间景。
// 推薦
if isFriendly {
print("你好, 遠(yuǎn)路來的朋友！")
} else {
print(“窮小子艺智，哪兒來的倘要？")
}
// 不推薦
guard isFriendly else {
print("窮小子，哪兒來的十拣？")
return
}
print("你好, 遠(yuǎn)路來的朋友封拧！")
3.11.5 你只應(yīng)該在在失敗情形下退出當(dāng)前上下文的場(chǎng)景下使用 guard 語句，下面的例子可以解釋 if 語句有時(shí)候比 guard 語句更合適 – 我們有兩個(gè)不相關(guān)的條件夭问，不應(yīng)該相互阻塞泽西。
if let monkeyIsland = monkeyIsland {
bookVacation(onIsland: monkeyIsland)
}
if let woodchuck = woodchuck where canChuckWood(woodchuck) {
woodchuck.chuckWood()
}
3.11.6 我們會(huì)經(jīng)常遇到使用 guard 語句拆包多個(gè)可選值，如果所有拆包失敗的錯(cuò)誤處理都一致可以把拆包組合到一起 (如 return, break, continue,throw 等).
// 組合在一起因?yàn)榭赡芰⒓捶祷?guard let thingOne = thingOne,
let thingTwo = thingTwo,
let thingThree = thingThree else {
return
}
// 使用獨(dú)立的語句 因?yàn)槊總€(gè)場(chǎng)景返回不同的錯(cuò)誤
guard let thingOne = thingOne else {
throw Error(message: "Unwrapping thingOne failed.")
}
guard let thingTwo = thingTwo else {
throw Error(message: "Unwrapping thingTwo failed.")
}
guard let thingThree = thingThree else {
throw Error(message: "Unwrapping thingThree failed.")
}
4. 文檔/注釋
4.1 文檔
如果一個(gè)函數(shù)比 O(1) 復(fù)雜度高缰趋，你需要考慮為函數(shù)添加注釋捧杉，因?yàn)楹瘮?shù)簽名(方法名和參數(shù)列表) 并不是那么的一目了然陕见，這里推薦比較流行的插件 VVDocumenter. 不論出于何種原因，如果有任何奇淫巧計(jì)不易理解的代碼味抖，都需要添加注釋评甜，對(duì)于復(fù)雜的 類/結(jié)構(gòu)體/枚舉/協(xié)議/屬性 都需要添加注釋。所有公開的 函數(shù)/類/變量/枚舉/協(xié)議/屬性/常數(shù) 也都需要添加文檔仔涩，特別是 函數(shù)聲明(包括名稱和參數(shù)列表) 不是那么清晰的時(shí)候蜕着。
寫文檔時(shí)，確保參照蘋果文檔中提及的標(biāo)記語法合集红柱。
在注釋文檔完成后，你應(yīng)檢查格式是否正確蓖乘。
規(guī)則:
4.1.1 一行不要超過160個(gè)字符 (和代碼長(zhǎng)度限制雷同).
4.1.2 即使文檔注釋只有一行锤悄，也要使用模塊化格式 (/** */).
4.1.3 注釋模塊中的空行不要使用 * 來占位。
4.1.4 確定使用新的 – parameter 格式嘉抒，而不是就得 Use the new -:param: 格式零聚，另外注意 parameter 是小寫的。
4.1.5 如果需要給一個(gè)方法的 參數(shù)/返回值/拋出異常 添加注釋些侍，務(wù)必給所有的添加注釋隶症，即使會(huì)看起來有部分重復(fù)，否則注釋會(huì)看起來不完整岗宣，有時(shí)候如果只有一個(gè)參數(shù)值得添加注釋蚂会，可以在方法注釋里重點(diǎn)描述。
4.1.6 對(duì)于負(fù)責(zé)的類耗式，在描述類的使用方法時(shí)可以添加一些合適的例子胁住，請(qǐng)注意Swift注釋是支持 MarkDown 語法的。
/**
## 功能列表
這個(gè)類提供下一下很贊的功能刊咳，如下:
- 功能 1
- 功能 2
- 功能 3
## 例子
這是一個(gè)代碼塊使用四個(gè)空格作為縮進(jìn)的例子彪见。
let myAwesomeThing = MyAwesomeClass()
myAwesomeThing.makeMoney()
## 警告
使用的時(shí)候總注意以下幾點(diǎn)
1. 第一點(diǎn)
2. 第二點(diǎn)
3. 第三點(diǎn)
*/
class MyAwesomeClass {
/* ... */
}
4.1.8 在寫文檔注釋時(shí)，盡量保持簡(jiǎn)潔娱挨。
4.2 其他注釋原則
4.2.1 // 后面要保留空格余指。
4.2.2 注釋必須要另起一行。
4.2.3 使用注釋 // MARK: - xoxo 時(shí), 下面一行保留為空行跷坝。
class Pirate {
// MARK: - 實(shí)例屬性
private let pirateName: String
// MARK: - 初始化
init() {
/* ... */
}
}
翻譯作者：碼農(nóng)網(wǎng) – 豆照建
