代碼格式
- 使用Tab(四個(gè)空格)進(jìn)行縮進(jìn)
- 文件的結(jié)尾應(yīng)該留一空白行
- 左大括號(hào)不用另起一行
func someMethod() {
if x == y {
/* ... */
} else if x == z {
/* ... */
} else {
/* ... */
}
}
- 當(dāng)在寫一個(gè)變量類型匙睹,一個(gè)字典里的主鍵,一個(gè)函數(shù)的參數(shù),遵從一個(gè)協(xié)議潮瓶,或一個(gè)父類,不用在分號(hào)前添加空格
// 指定類型
let pirateViewController: PirateViewController
// 字典語(yǔ)法(注意這里是向左對(duì)齊而不是分號(hào)對(duì)齊)
let ninjaDictionary: [String: AnyObject] = [
"fightLikeDairyFarmer": false,
"disgusting": true
]
// 聲明函數(shù)
func myFunction(firstArgument: U, secondArgument: T) {
/* ... */
}
// 調(diào)用函數(shù)
someFunction(someArgument: "Kitten")
// 父類
class PirateViewController: UIViewController {
/* ... */
}
// 協(xié)議
extension PirateViewController: UITableViewDataSource {
/* ... */
}
- 逗號(hào)钙姊、二元運(yùn)算符(+, -, /, = , ->)的前后都需要添加空格
let myValue = 20 + (30 / 2) * 3
if 1 + 1 == 3 {
fatalError("The universe is broken.")
}
func pancake() -> Pancake {
/* ... */
}
- 每個(gè)函數(shù)之間需要換一行筋讨,函數(shù)內(nèi)切勿盲目換行,一般有關(guān)聯(lián)的作為一部分空格摸恍,一般return之前添加空一行
命名
- 能準(zhǔn)確直觀的表達(dá)意圖
// 推薦
class RoundAnimatingButton: UIButton { /* ... */ }
// 不推薦
class CustomButton: UIButton { /* ... */ }
- 在Swift中不需要如Objective-C式 一樣添加前綴
//不推薦
class MGLoginIMServices
//推薦
class LoginIMServices
-
命名符合項(xiàng)目上下文命名習(xí)慣
在命名時(shí)最好能符合整個(gè)項(xiàng)目的命名習(xí)慣悉罕,比如大家都用selectXXX表示查詢的話赤屋,就不要用queryXXX,當(dāng)大家都用insertXXX表示插入數(shù)據(jù)的話壁袄,就不要用addXXX类早,當(dāng)大家都用getXXX表示獲取數(shù)據(jù)的時(shí)候,就不要用fetchXXX嗜逻。其目的是要要與實(shí)際項(xiàng)目命名統(tǒng)一涩僻。 -
盡量不用英文縮寫
當(dāng)然對(duì)于一些大眾熟知的縮寫還是可以用的比如URL、Http栈顷、ID等逆日,但是比如Button就沒必要寫縮寫B(tài)tn了
// 推薦
class RoundAnimatingButton: UIButton {
let animationDuration: NSTimeInterval
func startAnimating() {
let firstSubview = subviews.first
}
}
// 不推薦
class RoundAnimating: UIButton {
let aniDur: NSTimeInterval
func srtAnmating() {
let v = subviews.first
}
}
-
使用小駱駝拼寫法 (首字母小寫) 為函數(shù),方法萄凤,變量室抽,常量,參數(shù)等命名
一般函數(shù)的命名開頭一般為動(dòng)詞 -
使用大駱駝拼寫法為類型命名
如struct, enum, class, typedef, associatedtype等靡努,一般以名詞開頭來(lái)命名 - 利用上下文簡(jiǎn)化命名
// 不推薦
struct User {
private var userName: String
private var userPassword: String
private var userAvatarUrl: String
}
//推薦
struct User {
private var name: String
private var password: String
private var avatarUrl: String
}
- 使用前綴k+大駱駝命名法為所有非單例的靜態(tài)常量命名
class MyClassName {
// 基元常量使用 k 作為前綴
static let kSomeConstantHeight: CGFloat = 80.0
// 非基元常量也是用 k 作為前綴
static let kDeleteButtonColor = UIColor.redColor()
// 對(duì)于單例不要使用k作為前綴
static let sharedInstance = MyClassName()
/* ... */
}
- 如果協(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
/* ... */
}
- 對(duì)于以UI控件作為屬性的命名需要包含類型信息
// 推薦
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!
}
代碼風(fēng)格
- 常量取代魔法數(shù)字
//推薦
private static let PI = 3.14159
func calculateCircularArea(radius: Double) -> Double {
return PI * radius * radius
}
//不推薦
func calculateCircularArea(radius: Double) -> Double {
return 3.14159 * radius * radius
}
-
盡可能的多使用let辟灰,少使用var
盡可能的用 let foo = ... 而不是 var foo = ... (并且包括你疑惑的時(shí)候)。萬(wàn)不得已的時(shí)候篡石,再用 var (就是說(shuō):你 知道 這個(gè)值會(huì)改變芥喇,比如:有 weak 修飾的存儲(chǔ)變量)。 - 如果變量類型可以依靠推斷得出凰萨,不建議聲明變量時(shí)指明類型
- 當(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)
}
}
- 在寫枚舉類型的時(shí)候,盡量用簡(jiǎn)寫
// 推薦
imageView.setImageWithURL(url, type: .person)
// 不推薦
imageView.setImageWithURL(url, type: AsyncImageView.Type.person)
-
只有在需要的情況下才使用self
當(dāng)調(diào)用 self 的屬性或方法時(shí)胖眷,默認(rèn)隱式引用self:
private class History {
var events: [Event]
func rewrite() {
events = []
}
}
必要的時(shí)候再加上self,比如在閉包里,或者參數(shù)名沖突了:
extension History {
init(events: [Event]) {
self.events = events
}
var whenVictorious: () -> () {
return {
self.rewrite()
}
}
}
-
在閉包里使用 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()
}
- switch-case里不用顯式添加break
-
函數(shù)最多包含4個(gè)參數(shù)
當(dāng)我們不得不需要輸入多個(gè)參數(shù)的時(shí)候,可以有以下2種方式處理:
1珊搀、考慮函數(shù)是否職責(zé)單一冶忱,是否能通過(guò)拆分成多個(gè)函數(shù)的方式來(lái)減少參數(shù);
2食棕、把函數(shù)的參數(shù)封裝成對(duì)象朗和。 - 函數(shù)有多個(gè)返回值错沽,推薦使用元組簿晓,如果返回的元組有三個(gè)或多于三個(gè)以上的元素,建議使用結(jié)構(gòu)體或類
- 如果需要把訪問修飾符放到第一個(gè)位置
// 推薦
private static let kMyPrivateNumber: Int
// 不推薦
static private let kMyPrivateNumber: Int
-
避免閉包的內(nèi)循環(huán)
閉包中對(duì)任何其他元素的引用都是會(huì)被閉包自動(dòng)持有的千埃。如果我們?cè)陂]包中寫了 self 這樣的東西的話憔儿,那我們其實(shí)也就在閉包內(nèi)持有了當(dāng)前的對(duì)象。這里就出現(xiàn)了一個(gè)在實(shí)際開發(fā)中比較隱蔽的陷阱:如果當(dāng)前的實(shí)例直接或者間接地對(duì)這個(gè)閉包又有引用的話放可,就形成了一個(gè) self -> 閉包 -> self 的循環(huán)引用谒臼,簡(jiǎn)單例子:
class Person {
let name: String
lazy var printName: ()->() = {
print("The name is \(self.name)")
}
init(name: String) {
self.name = name
}
deinit {
print("Person deinit \(self.name)")
}
}
var xiaoMing: Person? = Person(name: "XiaoMing")
xiaoMing!.printName()
xiaoMing = nil
// 輸出:
// The name is XiaoMing,沒有被釋放
//推薦做法
lazy var printName: ()->() = {
[weak self] in
if let strongSelf = self {
print("The name is \(strongSelf.name)")
}
}
-
避免對(duì)可選類型強(qiáng)解包
如果你有個(gè) FooType? 或 FooType! 的 foo耀里,盡量不要強(qiáng)行展開它(foo!)以得到它的關(guān)聯(lián)值蜈缤。取而代之的,推薦這樣:
//推薦1:if let
if let foo = foo {
// Use unwrapped `foo` value in here
} else {
// If appropriate, handle the case where the optional is nil
}
//推薦2:使用可選鏈
// Call the function if `foo` is not nil. If `foo` is nil, ignore we ever tried to make the call
foo?.callSomethingIfFooIsNotNil()
-
避免隱式解析的可選類型
唯一使用隱式拆包可選型(implicitly unwrapped optionals)的場(chǎng)景是結(jié)合@IBOutlets
在其他場(chǎng)景使用非可選類型和常規(guī)可選類型冯挎,即使有的場(chǎng)景你確定有的變量使用的時(shí)候永遠(yuǎn)不會(huì)為nil底哥,但這樣做可以保持一致性和程序更加健壯, 隱式解析的可選類型存在運(yùn)行時(shí)崩潰的風(fēng)險(xiǎn)。 -
實(shí)現(xiàn)協(xié)議的方式
1房官、使用 // MARK: 注釋來(lái)分割協(xié)議實(shí)現(xiàn)和其他代碼趾徽。
2、使用 extension 在 類/結(jié)構(gòu)體已有代碼外翰守,但在推薦在同一個(gè)文件內(nèi)孵奶。 - 在創(chuàng)建類常量的時(shí)候,使用 static 關(guān)鍵詞修飾
class MyTableViewCell: UITableViewCell {
static let kReuseIdentifier = String(MyTableViewCell)
static let kCellHeight: CGFloat = 80.0
}
- 推薦定義單例的方式
class PirateManager {
static let sharedInstance = PirateManager()
/* ... */
}
-
盡早地 return 或者 break
當(dāng)你遇到某些操作需要通過(guò)條件判斷去執(zhí)行蜡峰,應(yīng)當(dāng)盡早地退出判斷條件:
//不推薦
if n.isNumber {
// Use n here
} else {
return
}
//推薦
guard n.isNumber else {
return
}
// Use n here