File: /www/wwwroot/outofmemory.cn/tmp/plugin_ss_superseo_model_superseo.php, Line: 473, decode(
概述1.
格式 1.1 使用四个空格进行缩进。 1.2 每行最多160个字符，这样可以避免一行过长。 (Xcode->Preferences->Text Editing->Page guide at column: 设置成160即可) 1.3 确保每个文件结尾都有空白行。 1.4 确保每行都不以空白字符作为结尾 （Xcode->Preferences->Text Editing->Automati
1.2 每行最多160个字符，这样可以避免一行过长。 (Xcode->Preferences->Text Editing->Page guIDe at column: 设置成160即可)
1.4 确保每行都不以空白字符作为结尾 （Xcode->Preferences->Text Editing->automatically trim trailing whitespace + Including whitespace-only lines).
7 let myValue = 20 + (30 / 2) * 3 1 + 1 == 3 { fatalError( "The universe is broken." ) } func pancake() -> Pancake { /* ... */ 1.9 遵守Xcode内置的缩进格式( 如果已经遵守，按下CTRL-i 组合键文件格式没有变化)。当声明的一个函数需要跨多行时，推荐使用Xcode默认的格式，目前Xcode 版本是 7.3。 13 // Xcode针对跨多行函数声明缩进 func myFunctionWithManyParameters(parameterOne: String, parameterTwo: String, parameterThree: String) { // Xcode会自动缩进 print( "\(parameterOne) \(parameterTwo) \(parameterThree)" ) } // Xcode针对多行 if 语句的缩进 myFirstvariable > (mySecondVariable + myThirdVariable) && myFourthVariable == .someEnumValue { // Xcode会自动缩进 "Hello, World!" ) 1.10 当调用的函数有多个参数时，每一个参数另起一行，并比函数名多一个缩进。 4 someFunctionWithManyArguments( firstArgument: 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() firstCondition && secondCondition && thirdCondition { // 你要干什么 // 不推荐 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 首字母缩略词在命名中一般来说都是全部大写，例外的情形是如果首字母缩略词是一个命名的开始部分，而这个命名需要小写字母作为开头，这种情形下首字母缩略词全部小写。
8 // "HTML" 是变量名的开头, 需要全部小写 "HTML" let HTMLBodyContent: String = "<p>Hello, World!</p>" // 推荐使用 ID 而不是 ID let profileID: Int = 1 // 推荐使用 URLFinder 而不是 UrlFinder class URLFinder { /* ... */ 2.5 使用前缀 k + 大骆驼命名法 为所有非单例的静态常量命名。 9 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 }</model></t>
2.7 命名应该具有描述性 和 清晰的。
class RoundAnimatingbutton: UIbutton { } // 不推荐 class Custombutton: UIbutton { 2.8 不要缩写，简写命名，或用单个字母命名。 14 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 如果原有命名不能明显表明类型，则属性命名内要包括类型信息。 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 @H_301_769@ 40 41 42 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! emailTextFIEld: UITextFIEld! 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 btnsubmit: UIbutton! buttonsubmit: UIbutton! // 在使用outlets 时，变量名内应包含类型名。 // 这里建议使用 firstnameLabel firstname: UILabel! 2.10 当给函数参数命名时，要确保函数能理解每个参数的目的。 2.11 根据苹果接口设计指导文档,如果协议描述的是协议做的事应该命名为名词(如Collection) ，如果描述的是行为，需添加后缀 able 或 ing (如Equatable 和 ProgressReporting)。 如果上述两者都不能满足需求，可以添加Protocol作为后缀，例子见下面。
17 // 这个协议描述的是协议能做的事，应该命名为名词。 protocol tableVIEwSectionProvIDer { func rowHeight(atRow row: Int) -> CGfloat 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。
18 let stringOfInts = [1, 3].flatMap { String($0) } // ["1", "2", "3"] // 不推荐 stringOfInts: [String] = [] for integer in [1, 3] { stringOfInts.append(String(integer)) } // 推荐 let evennumbers = [4, 8, 15, 16, 23, 42].filter { // [4, 42] % 2 == 0 } // 不推荐 evennumbers: [Int] = [] [4, 42] { integer % 2 == 0 { evennumbers(integer) } return 3.1.3 如果变量类型可以依靠推断得出，不建议声明变量时指明类型。 3.1.4 如果一个函数有多个返回值，推荐使用 元组 而不是 inout 参数， 如果你见到一个元组多次，建议使用typealias ，而如果返回的元组有三个或多于三个以上的元素，建议使用结构体或类。
6 func piratename() -> (firstname: String, lastname: String) { ( "Guybrush" "Threepwood" ) } let name = piratename() let firstname = name.firstname let lastname = name.lastname in
3.1.5 当使用委托和协议时，请注意避免出现循环引用，基本上是在定义属性的时候使用 weak 修饰。
3.1.6 在闭包里使用 self 的时候要注意出现循环引用，使用捕获列表可以避免这一点。
myFunctionWithClosure() { [weak self] (error) -> VoID // 方案 1 self?.doSomething() // 或方案 2 guard let strongSelf = self { return } strongSelf.doSomething() x == y { 3.1.7 Switch 模块中不用显式使用break。 3.1.8 断言流程控制的时候不要使用小括号。
// 推荐 /* ... */ } // 不推荐 (x == y) { imageVIEw.backgroundcolor = .whitecolor() 3.1.9 在写枚举类型的时候，尽量简写。 imageVIEw.setimageWithURL(url, type: .person) 3.1.10 在使用类方法的时候不用简写，因为类方法不如 枚举 类型一样，可以根据轻易地推导出上下文。 imageVIEw.backgroundcolor = UIcolor.whitecolor() someBoolean {
3.1.11 不建议使用用self.修饰除非需要。
3.1.12 在新写一个方法的时候，需要衡量这个方法是否将来会被重写，如果不是，请用 final 关键词修饰，这样阻止方法被重写。一般来说，final 方法可以优化编译速度，在合适的时候可以大胆使用它。但需要注意的是，在一个公开发布的代码库中使用 final 和本地项目中使用 final 的影响差别很大的。
3.1.13 在使用一些语句如 else，catch等紧随代码块的关键词的时候，确保代码块和关键词在同一行。下面 if/else 和 do/catch 的例子.
10 // 你想要什么 { // 你不想做什么 } do { let fileContents = try readfile( "filename.txt" ) catch { print(error) static private let kMyPrivateNumber: Int 3.2 访问控制修饰符 3.2.1 如果需要把访问修饰符放到第一个位置。
private static let kMyPrivateNumber: Int // 不推荐
3.2.2 访问修饰符不应单独另起一行，应和访问修饰符描述的对象保持在同一行。
public class Pirate { public class Pirate { 3.2.3 默认的访问控制修饰符是 internal,如果需要使用internal 可以省略不写。 3.2.4 当一个变量需要被单元测试 访问时，需要声明为 internal 类型来使用@testable import {Modulename}。 如果一个变量实际上是private 类型，而因为单元测试需要被声明为 internal 类型，确定添加合适的注释文档来解释为什么这么做。这里添加注释推荐使用 - warning: 标记语法。
5 /** 这个变量是private 名字 - warning: 定义为 internal 而不是 private 为了 `@testable`. */ let piratename = "LeChuck" case
3.3 自定义 *** 作符
不推荐使用自定义 *** 作符，如果需要创建函数来替代。
在重写 *** 作符之前，请慎重考虑是否有充分的理由一定要在全局范围内创建新的 *** 作符，而不是使用其他策略。
你可以重载现有的 *** 作符来支持新的类型(特别是 ==)，但是新定义的必须保留 *** 作符的原来含义，比如 == 必须用来测试是否相等并返回布尔值。
3.4 Switch 语句 和 枚举
3.4.1 在使用 Switch 语句时，如果选项是有限集合时，不要使用default，相反地，把一些不用的选项放到底部，并用 break 关键词 阻止其执行。
3.4.2 因为Swift 中的 switch 选项默认是包含break的， 如果不需要不用使用 break 关键词。
3.4.3 case 语句 应和 switch 语句左对齐，并在 标准的 default 上面。
3.4.4 当定义的选项有关联值时，确保关联值有恰当的名称，而不只是类型。(如. 使用 case Hunger(hungerLevel: Int) 而不是 case Hunger(Int)).
@H_571_1404@ 15 enum Problem { attitude hair hunger(hungerLevel: Int) func handleProblem(problem: Problem) { switch problem { .attitude: "At least I don't have a hair problem." ) .hair: "Your barber dIDn't kNow when to stop." ) .hunger(let hungerLevel): "The hunger level is \(hungerLevel)." ) } 0, 1, 5, 6, 7, 9: 3.4.5 推荐尽可能使用fall through。 3.4.6 如果default 的选项不应该触发，可以抛出错误 或 断言类似的做法。
func handleDigit(digit: Int) throws { "Yes, \(digit) is a digit!" ) default : throw Error(message: "The given number was not a digit." ) // 你要做什么 3.5 可选类型 3.5.1 唯一使用隐式拆包可选型（implicitly unwrapped optionals）的场景是结合@IBOutlets，在其他场景使用 非可选类型 和 常规可选类型，即使有的场景你确定有的变量使用的时候永远不会为 nil， 但这样做可以保持一致性和程序更加健壮。
3.5.2 不要使用 as! 或 try!。
3.5.3 如果对于一个变量你不打算声明为可选类型，但当需要检查变量值是否为 nil，推荐用当前值和 nil 直接比较，而不推荐使用 if let 语法。
someOptional != nil { let _ = someOptional { // 你要做什么 parentVIEwController: UIVIEwController? 3.5.4 不要使用 uNowned，uNowned 和 weak 变量基本上等价，并且都是隐式拆包( uNowned 在引用计数上有少许性能优化)，由于不推荐使用隐式拆包，也不推荐使用uNowned 变量。 weak parentVIEwController: UIVIEwController! uNowned parentVIEwController: UIVIEwController 3.5.5 当拆包取值时，使用和被拆包取值变量相同的名称。 guard let myVariable = myVariable return someBool { 3.6 协议 在实现协议的时候，有两种方式来组织你的代码:
使用 // MARK: 注释来分割协议实现和其他代码。
使用 extension 在 类/结构体已有代码外，但在同一个文件内。
请注意 extension 内的代码不能被子类重写，这也意味着测试很难进行。 如果这是经常发生的情况，为了代码一致性最好统一使用第一种办法。否则使用第二种办法，其可以代码分割更清晰。
使用而第二种方法的时候，使用 // MARK: 依然可以让代码在 Xcode 可读性更强。
3.7 属性
3.7.1 对于只读属性，计算后(Computed)属性,提供 getter 而不是 get {}。
computedProperty: String { return "I'm a mighty pirate!" } "I'm selling these fine leather jackets." someBool { 3.7.2 对于属性相关方法 get {},set {},willSet,和 dIDSet,确保缩进相关代码块。 3.7.3 对于willSet/dIDSet 和 set 中的旧值和新值虽然可以自定义名称，但推荐使用默认标准名称 newValue/oldValue。
get { "I'm a mighty pirate!" } "I'm selling these fine leather jackets." set { computedProperty = newValue willSet { "will set to \(newValue)" ) } dIDSet { "dID set from \(oldValue) to \(newValue)" ) } static let kReuseIDentifIEr = String(MytableVIEwCell) 3.7.4 在创建类常量的时候，使用 static 关键词修饰。 class MytableVIEwCell: UItableVIEwCell { static let kCellHeight: CGfloat = 80.0 static let sharedInstance = PirateManager() 3.7.5 声明单例属性可以通过下面方式进行： class PirateManager { doSomethingWithClosure() { response 3.8 闭包 3.8.1 如果参数的类型很明显，可以在函数名里可以省略参数类型,但明确声明类型也是允许的。 代码的可读性有时候是添加详细的信息，而有时候部分重复，根据你的判断力做出选择吧，但前后要保持一致性。
@H_419_1699@ // 省略类型 in print(response) // 明确指出类型 doSomethingWithClosure() { response: NSURLResponse in print(response) // map 语句使用简写 doSomethingWithClosure() { [weak self] (response: NSURLResponse) 3.8.2 如果使用捕捉列表 或 有具体的非 VoID返回类型，参数列表应该在小括号内， 否则小括号可以省略。 // 因为使用捕捉列表，小括号不能省略。 self?.handleResponse(response) // 因为返回类型，小括号不能省略。 doSomethingWithClosure() { (response: NSURLResponse) -> String String(response) "Success? \(success)" 3.8.3 如果闭包是变量类型，不需把变量值放在括号中，除非需要，如变量类型是可选类型(Optional?)， 或当前闭包在另一个闭包内。确保闭包里的所以参数放在小括号中，这样()表示没有参数，VoID 表示不需要返回值。 let completionBlock: (success: Bool) -> VoID = { let completionBlock: () -> VoID = { "Completed!" let completionBlock: (() -> VoID)? = nil guard let file = openfile(filename)
3.9 数组
3.9.1 基本上不要通过下标直接访问数组内容，如果可能使用如 .first 或 .last,因为这些方法是非强制类型并不会崩溃。 推荐尽可能使用 for item in items 而不是 for i in 0..<items.count 遍历数组。="" 如果需要通过下标访问数组内容，在使用前要做边界检查。<="" p="">
3.9.2 不要使用 += 或 + *** 作符给数组添加新元素，使用性能较好的.append() 或.appendContentsOf() ，如果需要声明数组基于其他的数组并保持不可变类型， 使用 let myNewArray = [arr1,arr2].flatten()，而不是let myNewArray = arr1 + arr2 。
3.10 错误处理
假设一个函数 myFunction 返回类型声明为 String，但是总有可能函数会遇到error，有一种解决方案是返回类型声明为 String?,当遇到错误的时候返回 nil。
例子:
16 func readfile(withfilename filename: String) -> String? { { nil let fileContents = file.read() file.close() fileContents } func printSomefile() { let filename = "somefile.txt" guard let fileContents = readfile(filename) { "不能打开 \(filename)." return } print(fileContents) public let file: StaticString 实际上如果预知失败的原因，我们应该使用Swift 中的 try/catch 。 定义 错误对象 结构体如下:
12 struct Error: ErrorType { 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 } Error(message: “打不开的文件名称 \(filename).") 使用案例: func readfile(withfilename filename: String) throws -> String { { readfile(filename) print(fileContents) { print(error) } [+++] 其实项目中还是有一些场景更适合声明为可选类型，而不是错误捕捉和处理，比如在获取远端数据过程中遇到错误，nil作为返回结果是合理的，也就是声明返回可选类型比错误处理更合理。 整体上说，如果一个方法有可能失败，并且使用可选类型作为返回类型会导致错误原因湮没，不妨考虑抛出错误而不是吃掉它。
3.11 使用 guard 语句
3.11.1 总体上，我们推荐使用提前返回的策略，而不是 if 语句的嵌套。使用 guard 语句可以改善代码的可读性。
总结 以上是内存溢出为你收集整理的最详尽的 Swift 代码规范 指南 全部内容，希望文章能够帮你解决最详尽的 Swift 代码规范指南 所遇到的程序开发问题。
如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。
) 最详尽的 Swift 代码规范指南_app_内存溢出
首页
app
最详尽的 Swift 代码规范指南
back
•
2022-5-23
•
app
•
阅读 128
概述1.
代码 格式 1.1 使用四个空格进行缩进。 1.2 每行最多160个字符，这样可以避免一行过长。 (Xcode->Preferences->Text Editing->Page guide at column: 设置成160即可) 1.3 确保每个文件结尾都有空白行。 1.4 确保每行都不以空白字符作为结尾 （Xcode->Preferences->Text Editing->Automati
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 左大括号不用另起一行。
1 2 3 4 5 6 7 8 9 10 11 12 class SomeClass { func someMethod() { if x == y { /* ... */ } else x == z { /* ... */ else { /* ... */ } } /* ... */ }
1.6 当在写一个变量类型，一个字典里的主键，一个函数的参数，遵从一个协议，或一个父类，不用在分号前添加空格。
12 13 14 15 16 17 18 19 20 21 // 指定类型 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 { /* ... */ }</t, u: someprotocol where t.relatedtype == u>
1.7 基本来说，要在逗号后面加空格。
1 let myArray = [1, 2, 3, 4, 5]
1.8 二元运算符(+,==,或->)的前后都需要添加空格，左小括号后面和右小括号前面不需要空格。
7 let myValue = 20 + (30 / 2) * 3 1 + 1 == 3 { fatalError( "The universe is broken." ) } func pancake() -> Pancake { /* ... */ 1.9 遵守Xcode内置的缩进格式( 如果已经遵守，按下CTRL-i 组合键文件格式没有变化)。当声明的一个函数需要跨多行时，推荐使用Xcode默认的格式，目前Xcode 版本是 7.3。 13 // Xcode针对跨多行函数声明缩进 func myFunctionWithManyParameters(parameterOne: String, parameterTwo: String, parameterThree: String) { // Xcode会自动缩进 print( "\(parameterOne) \(parameterTwo) \(parameterThree)" ) } // Xcode针对多行 if 语句的缩进 myFirstvariable > (mySecondVariable + myThirdVariable) && myFourthVariable == .someEnumValue { // Xcode会自动缩进 "Hello, World!" ) 1.10 当调用的函数有多个参数时，每一个参数另起一行，并比函数名多一个缩进。 4 someFunctionWithManyArguments( firstArgument: 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() firstCondition && secondCondition && thirdCondition { // 你要干什么 // 不推荐 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 首字母缩略词在命名中一般来说都是全部大写，例外的情形是如果首字母缩略词是一个命名的开始部分，而这个命名需要小写字母作为开头，这种情形下首字母缩略词全部小写。
8 // "HTML" 是变量名的开头, 需要全部小写 "HTML" let HTMLBodyContent: String = "<p>Hello, World!</p>" // 推荐使用 ID 而不是 ID let profileID: Int = 1 // 推荐使用 URLFinder 而不是 UrlFinder class URLFinder { /* ... */ 2.5 使用前缀 k + 大骆驼命名法 为所有非单例的静态常量命名。 9 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 }</model></t>
2.7 命名应该具有描述性 和 清晰的。
class RoundAnimatingbutton: UIbutton { } // 不推荐 class Custombutton: UIbutton { 2.8 不要缩写，简写命名，或用单个字母命名。 14 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 如果原有命名不能明显表明类型，则属性命名内要包括类型信息。 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 @H_301_769@ 40 41 42 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! emailTextFIEld: UITextFIEld! 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 btnsubmit: UIbutton! buttonsubmit: UIbutton! // 在使用outlets 时，变量名内应包含类型名。 // 这里建议使用 firstnameLabel firstname: UILabel! 2.10 当给函数参数命名时，要确保函数能理解每个参数的目的。 2.11 根据苹果接口设计指导文档,如果协议描述的是协议做的事应该命名为名词(如Collection) ，如果描述的是行为，需添加后缀 able 或 ing (如Equatable 和 ProgressReporting)。 如果上述两者都不能满足需求，可以添加Protocol作为后缀，例子见下面。
17 // 这个协议描述的是协议能做的事，应该命名为名词。 protocol tableVIEwSectionProvIDer { func rowHeight(atRow row: Int) -> CGfloat 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。
18 let stringOfInts = [1, 3].flatMap { String($0) } // ["1", "2", "3"] // 不推荐 stringOfInts: [String] = [] for integer in [1, 3] { stringOfInts.append(String(integer)) } // 推荐 let evennumbers = [4, 8, 15, 16, 23, 42].filter { // [4, 42] % 2 == 0 } // 不推荐 evennumbers: [Int] = [] [4, 42] { integer % 2 == 0 { evennumbers(integer) } return 3.1.3 如果变量类型可以依靠推断得出，不建议声明变量时指明类型。 3.1.4 如果一个函数有多个返回值，推荐使用 元组 而不是 inout 参数， 如果你见到一个元组多次，建议使用typealias ，而如果返回的元组有三个或多于三个以上的元素，建议使用结构体或类。
6 func piratename() -> (firstname: String, lastname: String) { ( "Guybrush" "Threepwood" ) } let name = piratename() let firstname = name.firstname let lastname = name.lastname in
3.1.5 当使用委托和协议时，请注意避免出现循环引用，基本上是在定义属性的时候使用 weak 修饰。
3.1.6 在闭包里使用 self 的时候要注意出现循环引用，使用捕获列表可以避免这一点。
myFunctionWithClosure() { [weak self] (error) -> VoID // 方案 1 self?.doSomething() // 或方案 2 guard let strongSelf = self { return } strongSelf.doSomething() x == y { 3.1.7 Switch 模块中不用显式使用break。 3.1.8 断言流程控制的时候不要使用小括号。
// 推荐 /* ... */ } // 不推荐 (x == y) { imageVIEw.backgroundcolor = .whitecolor() 3.1.9 在写枚举类型的时候，尽量简写。 imageVIEw.setimageWithURL(url, type: .person) 3.1.10 在使用类方法的时候不用简写，因为类方法不如 枚举 类型一样，可以根据轻易地推导出上下文。 imageVIEw.backgroundcolor = UIcolor.whitecolor() someBoolean {
3.1.11 不建议使用用self.修饰除非需要。
3.1.12 在新写一个方法的时候，需要衡量这个方法是否将来会被重写，如果不是，请用 final 关键词修饰，这样阻止方法被重写。一般来说，final 方法可以优化编译速度，在合适的时候可以大胆使用它。但需要注意的是，在一个公开发布的代码库中使用 final 和本地项目中使用 final 的影响差别很大的。
3.1.13 在使用一些语句如 else，catch等紧随代码块的关键词的时候，确保代码块和关键词在同一行。下面 if/else 和 do/catch 的例子.
10 // 你想要什么 { // 你不想做什么 } do { let fileContents = try readfile( "filename.txt" ) catch { print(error) static private let kMyPrivateNumber: Int 3.2 访问控制修饰符 3.2.1 如果需要把访问修饰符放到第一个位置。
private static let kMyPrivateNumber: Int // 不推荐
3.2.2 访问修饰符不应单独另起一行，应和访问修饰符描述的对象保持在同一行。
public class Pirate { public class Pirate { 3.2.3 默认的访问控制修饰符是 internal,如果需要使用internal 可以省略不写。 3.2.4 当一个变量需要被单元测试 访问时，需要声明为 internal 类型来使用@testable import {Modulename}。 如果一个变量实际上是private 类型，而因为单元测试需要被声明为 internal 类型，确定添加合适的注释文档来解释为什么这么做。这里添加注释推荐使用 - warning: 标记语法。
5 /** 这个变量是private 名字 - warning: 定义为 internal 而不是 private 为了 `@testable`. */ let piratename = "LeChuck" case
3.3 自定义 *** 作符
不推荐使用自定义 *** 作符，如果需要创建函数来替代。
在重写 *** 作符之前，请慎重考虑是否有充分的理由一定要在全局范围内创建新的 *** 作符，而不是使用其他策略。
你可以重载现有的 *** 作符来支持新的类型(特别是 ==)，但是新定义的必须保留 *** 作符的原来含义，比如 == 必须用来测试是否相等并返回布尔值。
3.4 Switch 语句 和 枚举
3.4.1 在使用 Switch 语句时，如果选项是有限集合时，不要使用default，相反地，把一些不用的选项放到底部，并用 break 关键词 阻止其执行。
3.4.2 因为Swift 中的 switch 选项默认是包含break的， 如果不需要不用使用 break 关键词。
3.4.3 case 语句 应和 switch 语句左对齐，并在 标准的 default 上面。
3.4.4 当定义的选项有关联值时，确保关联值有恰当的名称，而不只是类型。(如. 使用 case Hunger(hungerLevel: Int) 而不是 case Hunger(Int)).
@H_571_1404@ 15 enum Problem { attitude hair hunger(hungerLevel: Int) func handleProblem(problem: Problem) { switch problem { .attitude: "At least I don't have a hair problem." ) .hair: "Your barber dIDn't kNow when to stop." ) .hunger(let hungerLevel): "The hunger level is \(hungerLevel)." ) } 0, 1, 5, 6, 7, 9: 3.4.5 推荐尽可能使用fall through。 3.4.6 如果default 的选项不应该触发，可以抛出错误 或 断言类似的做法。
func handleDigit(digit: Int) throws { "Yes, \(digit) is a digit!" ) default : throw Error(message: "The given number was not a digit." ) // 你要做什么 3.5 可选类型 3.5.1 唯一使用隐式拆包可选型（implicitly unwrapped optionals）的场景是结合@IBOutlets，在其他场景使用 非可选类型 和 常规可选类型，即使有的场景你确定有的变量使用的时候永远不会为 nil， 但这样做可以保持一致性和程序更加健壮。
3.5.2 不要使用 as! 或 try!。
3.5.3 如果对于一个变量你不打算声明为可选类型，但当需要检查变量值是否为 nil，推荐用当前值和 nil 直接比较，而不推荐使用 if let 语法。
someOptional != nil { let _ = someOptional { // 你要做什么 parentVIEwController: UIVIEwController? 3.5.4 不要使用 uNowned，uNowned 和 weak 变量基本上等价，并且都是隐式拆包( uNowned 在引用计数上有少许性能优化)，由于不推荐使用隐式拆包，也不推荐使用uNowned 变量。 weak parentVIEwController: UIVIEwController! uNowned parentVIEwController: UIVIEwController 3.5.5 当拆包取值时，使用和被拆包取值变量相同的名称。 guard let myVariable = myVariable return someBool { 3.6 协议 在实现协议的时候，有两种方式来组织你的代码:
使用 // MARK: 注释来分割协议实现和其他代码。
使用 extension 在 类/结构体已有代码外，但在同一个文件内。
请注意 extension 内的代码不能被子类重写，这也意味着测试很难进行。 如果这是经常发生的情况，为了代码一致性最好统一使用第一种办法。否则使用第二种办法，其可以代码分割更清晰。
使用而第二种方法的时候，使用 // MARK: 依然可以让代码在 Xcode 可读性更强。
3.7 属性
3.7.1 对于只读属性，计算后(Computed)属性,提供 getter 而不是 get {}。
computedProperty: String { return "I'm a mighty pirate!" } "I'm selling these fine leather jackets." someBool { 3.7.2 对于属性相关方法 get {},set {},willSet,和 dIDSet,确保缩进相关代码块。 3.7.3 对于willSet/dIDSet 和 set 中的旧值和新值虽然可以自定义名称，但推荐使用默认标准名称 newValue/oldValue。
get { "I'm a mighty pirate!" } "I'm selling these fine leather jackets." set { computedProperty = newValue willSet { "will set to \(newValue)" ) } dIDSet { "dID set from \(oldValue) to \(newValue)" ) } static let kReuseIDentifIEr = String(MytableVIEwCell) 3.7.4 在创建类常量的时候，使用 static 关键词修饰。 class MytableVIEwCell: UItableVIEwCell { static let kCellHeight: CGfloat = 80.0 static let sharedInstance = PirateManager() 3.7.5 声明单例属性可以通过下面方式进行： class PirateManager { doSomethingWithClosure() { response 3.8 闭包 3.8.1 如果参数的类型很明显，可以在函数名里可以省略参数类型,但明确声明类型也是允许的。 代码的可读性有时候是添加详细的信息，而有时候部分重复，根据你的判断力做出选择吧，但前后要保持一致性。
@H_419_1699@ // 省略类型 in print(response) // 明确指出类型 doSomethingWithClosure() { response: NSURLResponse in print(response) // map 语句使用简写 doSomethingWithClosure() { [weak self] (response: NSURLResponse) 3.8.2 如果使用捕捉列表 或 有具体的非 VoID返回类型，参数列表应该在小括号内， 否则小括号可以省略。 // 因为使用捕捉列表，小括号不能省略。 self?.handleResponse(response) // 因为返回类型，小括号不能省略。 doSomethingWithClosure() { (response: NSURLResponse) -> String String(response) "Success? \(success)" 3.8.3 如果闭包是变量类型，不需把变量值放在括号中，除非需要，如变量类型是可选类型(Optional?)， 或当前闭包在另一个闭包内。确保闭包里的所以参数放在小括号中，这样()表示没有参数，VoID 表示不需要返回值。 let completionBlock: (success: Bool) -> VoID = { let completionBlock: () -> VoID = { "Completed!" let completionBlock: (() -> VoID)? = nil guard let file = openfile(filename)
3.9 数组
3.9.1 基本上不要通过下标直接访问数组内容，如果可能使用如 .first 或 .last,因为这些方法是非强制类型并不会崩溃。 推荐尽可能使用 for item in items 而不是 for i in 0..<items.count 遍历数组。="" 如果需要通过下标访问数组内容，在使用前要做边界检查。<="" p="">
3.9.2 不要使用 += 或 + *** 作符给数组添加新元素，使用性能较好的.append() 或.appendContentsOf() ，如果需要声明数组基于其他的数组并保持不可变类型， 使用 let myNewArray = [arr1,arr2].flatten()，而不是let myNewArray = arr1 + arr2 。
3.10 错误处理
假设一个函数 myFunction 返回类型声明为 String，但是总有可能函数会遇到error，有一种解决方案是返回类型声明为 String?,当遇到错误的时候返回 nil。
例子:
16 func readfile(withfilename filename: String) -> String? { { nil let fileContents = file.read() file.close() fileContents } func printSomefile() { let filename = "somefile.txt" guard let fileContents = readfile(filename) { "不能打开 \(filename)." return } print(fileContents) public let file: StaticString 实际上如果预知失败的原因，我们应该使用Swift 中的 try/catch 。 定义 错误对象 结构体如下:
12 struct Error: ErrorType { 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 } Error(message: “打不开的文件名称 \(filename).") 使用案例: func readfile(withfilename filename: String) throws -> String { { readfile(filename) print(fileContents) { print(error) } 其实项目中还是有一些场景更适合声明为可选类型，而不是错误捕捉和处理，比如在获取远端数据过程中遇到错误，nil作为返回结果是合理的，也就是声明返回可选类型比错误处理更合理。 整体上说，如果一个方法有可能失败，并且使用可选类型作为返回类型会导致错误原因湮没，不妨考虑抛出错误而不是吃掉它。
3.11 使用 guard 语句
3.11.1 总体上，我们推荐使用提前返回的策略，而不是 if 语句的嵌套。使用 guard 语句可以改善代码的可读性。
总结 以上是内存溢出为你收集整理的最详尽的 Swift 代码规范 指南 全部内容，希望文章能够帮你解决最详尽的 Swift 代码规范指南 所遇到的程序开发问题。
如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。
赞
(0)
打赏
微信扫一扫
支付宝扫一扫
评论列表（0条）