译文链接：http://www.codeceo.com/article/swift-style-guide.html 英文原文：Swift Style Guide 翻译作者：码农网 – 豆照建
1. 代码格式
1.1 使用四个空格进行缩进。
1.2 每行最多160个字符，这样可以避免一行过长。 (Xcode->Preferences->Text Editing->Page guide at column: 设置成160即可)
1.3 确保每个文件结尾都有空白行。
1.4 确保每行都不以空白字符作为结尾 （Xcode->Preferences->Text Editing->Automatically trim trailing whitespace + Including whitespace-only lines).
1.5 左大括号不用另起一行。
class SomeClass {
func someMethod() {
if x == y {
/* ... */
} else if x == z {
/* ... */
} else {
/* ... */
}
}
/* ... */
}
1.6 当在写一个变量类型，一个字典里的主键，一个函数的参数，遵从一个协议，或一个父类，不用在分号前添加空格。
// 指定类型 let pirateViewController: PirateViewController // 字典语法(注意这里是向左对齐而不是分号对齐) let ninjaDictionary: [String: AnyObject] = [ "fightLikeDairyFarmer": false, "disgusting": true ] // 声明函数 func myFunction<T,U: SomeProtocol where T.RelatedType == U>(firstArgument: U,secondArgument: T) { /* ... */ } // 调用函数 someFunction(someArgument: "Kitten") // 父类 class PirateViewController: UIViewController { /* ... */ } // 协议 extension PirateViewController: UITableViewDataSource { /* ... */ }
1.7 基本来说，要在逗号后面加空格。
let myArray = [1,2,3,4,5]
1.8 二元运算符(+,==,或->)的前后都需要添加空格，左小括号后面和右小括号前面不需要空格。
let myValue = 20 + (30 / 2) * 3
if 1 + 1 == 3 {
fatalError("The universe is broken.")
}
func pancake() -> Pancake {
/* ... */
}
1.9 遵守Xcode内置的缩进格式( 如果已经遵守，按下CTRL-i 组合键文件格式没有变化)。当声明的一个函数需要跨多行时，推荐使用Xcode默认的格式，目前Xcode 版本是 7.3。
// Xcode针对跨多行函数声明缩进 func myFunctionWithManyParameters(parameterOne: String, parameterTwo: String, parameterThree: String) { // Xcode会自动缩进 print("\(parameterOne) \(parameterTwo) \(parameterThree)") } // Xcode针对多行 if 语句的缩进 if myFirstvariable > (mySecondVariable + myThirdVariable) && myFourthVariable == .someEnumValue { // Xcode会自动缩进 print("Hello,World!") }
1.10 当调用的函数有多个参数时，每一个参数另起一行，并比函数名多一个缩进。
someFunctionWithManyArguments( firstArgument: "Hello,I am a string", secondArgument: resultFromSomeFunction() thirdArgument: someOtherLocalVariable)
1.11 当遇到需要处理的数组或字典内容较多需要多行显示时，需把 [ 和 ] 类似于方法体里的括号， 方法体里的闭包也要做类似处理。
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 应尽量避免出现多行断言，可使用本地变量或其他策略。
// 推荐 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 使用小骆驼拼写法 (首字母小写) 为函数，方法，变量，常量，参数等命名。
2.4 首字母缩略词在命名中一般来说都是全部大写，例外的情形是如果首字母缩略词是一个命名的开始部分，而这个命名需要小写字母作为开头，这种情形下首字母缩略词全部小写。
// "HTML" 是变量名的开头,需要全部小写 "html"
let htmlBodyContent: String = "<p>Hello,World!</p>"
// 推荐使用 ID 而不是 Id
let profileID: Int = 1
// 推荐使用 URLFinder 而不是 UrlFinder
class URLFinder {
/* ... */
}
2.5 使用前缀 k + 大骆驼命名法 为所有非单例的静态常量命名。
class MyClassName {
// 基元常量使用 k 作为前缀
static let kSomeConstantHeight: CGFloat = 80.0
// 非基元常量也是用 k 作为前缀
static let kDeleteButtonColor = UIColor.redColor()
// 对于单例不要使用k作为前缀
static let sharedInstance = MyClassName()
/* ... */
}
2.6 对于泛型和关联类型，可以使用单个大写字母，也可是遵从大骆驼命名方式并能描述泛型的单词。如果这个单词和要实现的协议或继承的父类有冲突，可以为相关类型或泛型名字添加 Type 作为后缀。
class SomeClass<T> { /* ... */ }
class SomeClass<Model> { /* ... */ }
protocol Modelable {
associatedtype Model
}
protocol Sequence {
associatedtype IteratorType: Iterator
}
2.7 命名应该具有描述性 和 清晰的。
// 推荐
class RoundAnimatingButton: UIButton { /* ... */ }
// 不推荐
class CustomButton: UIButton { /* ... */ }
2.8 不要缩写，简写命名，或用单个字母命名。
// 推荐
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 如果原有命名不能明显表明类型，则属性命名内要包括类型信息。
// 推荐
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,等，需要在命名里标名类型。
let popupTableViewController: UITableViewController
// 当使用outlets时,确保命名中标注类型。
@IBOutlet weak var submitButton: UIButton!
@IBOutlet weak var emailTextField: UITextField!
@IBOutlet weak var nameLabel: UILabel!
}
// 不推荐
class ConnectionTableViewCell: UITableViewCell {
// 这个不是 UIImage,不应该以Image 为结尾命名。
// 建议使用 personImageView
let personImage: UIImageView
// 这个不是String，应该命名为 textLabel
let text: UILabel
// animation 不能清晰表达出时间间隔
// 建议使用 animationDuration 或 animationTimeInterval
let animation: NSTimeInterval
// transition 不能清晰表达出是String
// 建议使用 transitionText 或 transitionString
let transition: String
// 这个是ViewController，不是View
let popupView: UIViewController
// 由于不建议使用缩写，这里建议使用 ViewController替换 VC
let popupVC: UIViewController
// 技术上讲这个变量是 UIViewController,但应该表达出这个变量是TableViewController
let popupViewController: UITableViewController
// 为了保持一致性，建议把类型放到变量的结尾，而不是开始，如submitButton
@IBOutlet weak var btnSubmit: UIButton!
@IBOutlet weak var buttonSubmit: UIButton!
// 在使用outlets 时，变量名内应包含类型名。
// 这里建议使用 firstNameLabel
@IBOutlet weak var firstName: UILabel!
}
2.10 当给函数参数命名时，要确保函数能理解每个参数的目的。
2.11 根据苹果接口设计指导文档,如果协议描述的是协议做的事应该命名为名词(如Collection) ，如果描述的是行为，需添加后缀 able 或 ing (如Equatable 和 ProgressReporting)。 如果上述两者都不能满足需求，可以添加Protocol作为后缀，例子见下面。
// 这个协议描述的是协议能做的事，应该命名为名词。
protocol TableViewSectionProvider {
func rowHeight(atRow row: Int) -> CGFloat
var numberOfRows: Int { get }
/* ... */
}
// 这个协议表达的是行为,以able最为后缀
protocol Loggable {
func logCurrentState()
/* ... */
}
// 因为已经定义类InputTextView，如果依然需要定义相关协议，可以添加Protocol作为后缀。
protocol InputTextViewProtocol {
func sendTrackingEvent()
func inputText() -> String
/* ... */
}
3. 代码风格
3.1 综合
3.1.1 尽可能的多使用let，少使用var。
3.1.2 当需要遍历一个集合并变形成另一个集合时，推荐使用函数 map,filter 和 reduce。
// 推荐
let stringOfInts = [1,3].flatMap { String($0) }
// ["1","2","3"]
// 不推荐
var stringOfInts: [String] = []
for integer in [1,3] {
stringOfInts.append(String(integer))
}
// 推荐
let evennumbers = [4,8,15,16,23,42].filter { $0 % 2 == 0 }
// [4,42]
// 不推荐
var evennumbers: [Int] = []
for integer in [4,42] {
if integer % 2 == 0 {
evennumbers(integer)
}
}
3.1.3 如果变量类型可以依靠推断得出，不建议声明变量时指明类型。
3.1.4 如果一个函数有多个返回值，推荐使用 元组 而不是 inout 参数， 如果你见到一个元组多次，建议使用typealias ，而如果返回的元组有三个或多于三个以上的元素，建议使用结构体或类。
func pirateName() -> (firstName: String,lastName: String) { return ("Guybrush","Threepwood") } let name = pirateName() let firstName = name.firstName let lastName = name.lastName
3.1.5 当使用委托和协议时，请注意避免出现循环引用，基本上是在定义属性的时候使用 weak 修饰。
3.1.6 在闭包里使用 self 的时候要注意出现循环引用，使用捕获列表可以避免这一点。
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 断言流程控制的时候不要使用小括号。
// 推荐
if x == y {
/* ... */
}
// 不推荐
if (x == y) {
/* ... */
}
3.1.9 在写枚举类型的时候，尽量简写。
// 推荐 imageView.setimageWithURL(url,type: .person) // 不推荐 imageView.setimageWithURL(url,type: AsyncImageView.Type.person)
3.1.10 在使用类方法的时候不用简写，因为类方法不如 枚举 类型一样，可以根据轻易地推导出上下文。
// 推荐 imageView.backgroundColor = UIColor.whiteColor() // 不推荐 imageView.backgroundColor = .whiteColor()
3.1.11 不建议使用用self.修饰除非需要。
3.1.12 在新写一个方法的时候，需要衡量这个方法是否将来会被重写，如果不是，请用 final 关键词修饰，这样阻止方法被重写。一般来说，final 方法可以优化编译速度，在合适的时候可以大胆使用它。但需要注意的是，在一个公开发布的代码库中使用 final 和本地项目中使用 final 的影响差别很大的。
3.1.13 在使用一些语句如 else，catch等紧随代码块的关键词的时候，确保代码块和关键词在同一行。下面 if/else 和 do/catch 的例子.
if someBoolean {
// 你想要什么
} else {
// 你不想做什么
}
do {
let fileContents = try readFile("filename.txt")
} catch {
print(error)
}
剩余部分请阅读：http://www.codeceo.com/article/swift-style-guide.html
长按二维码关注
