Swift 编程风格指南.pdfVIP

Swift 编程风格指南 语⾔ 使⽤美式英语拼写以匹配苹果公司的API 优选： var color = red 不建议使⽤： var colour = red 间隔 使⽤2个空格进⾏缩进⽽不是使⽤Tab ， 样可以节省空格，阻⽌换⾏。确保在 Xcode的配置项中进⾏了设置。 ⽅法的花括号以及其它花括号 （if/else/ switch/while等等）总是跟语句在 同⼀⾏开始，但是在新的⼀⾏中结束。 优选： if user.isHappy { //Do something } else { //Do something else } 不建议使⽤： if user.isHappy { //Do something } else { //Do something else } ⽅法之间应该总是⽤⼀空⽩⾏进⾏分隔以提⾼视觉以及结构上的清晰度。⽅法 中的空⽩符⽤来隔离功能块，但是如果⼀个⽅法中存在太多 种功能块时，通 常也意味着你需要将它重构为多个⽅法了。 注释 在需要的时候使⽤注释说明⼀块代码为什么 么做。注释必须时刻跟进代码， 不然删了得了。 因为代码应该尽可能的⾃⽂档化，所以避免在代码中使⽤成块的注释。例外： 该规则不适⽤与⽤于⽣成⽂档的成块注释。 命名 使⽤驼峰法为类、⽅法、变量等等取⼀个描述性强的名字。模块范围的类名以及常量 名称要以⼤写字母开头，⽽⽅法名跟变量名则应该以⼩写字母开头。 优选： let Maximum idgetCount = 100 class idgetContainer { var widgetButton: UIButton let widgetHeightPercentage = 0.85 } 不建议使⽤： let MAX_ IDGET_COUNT = 100 class app_widgetContainer { var wBut: UIButton let wHeightPct = 0.85 } 对于普通函数以及构造函数名称，除⾮上下⽂含义⾮常清楚，对所有的参数都加以命 名是更为推荐的做法。如果外部参数名称可以使得函数调⽤更具有可读性，那么请带 上它。 func dateFromString(dateString: NSString) - NSDate func convertPointAt(#column: Int, #row : Int) - CGPoint func timedAction(#delay : NSTimeInterval, perform action: SKAction // 会被这样调⽤ dateFromString(2014-03-14) convertPointAt(column: 42, row : 13) timedAction(delay : 1.0, perform: someOtherAction) 对于⽅法，遵循苹果公司的命名标准，在⽅法名中提及第⼀个参数： class Guideline { func combine ithString(incoming: String, options: Dictionary?) func upvoteBy(amount: Int) { ... } } 在所有提及到函数的内容中 （包括教程，书以及评论），请从调⽤者的视⾓进⾏考 虑，将所有的必要参数名都包含进来： dateFromString()函数真是太棒了。 在你的init()⽅法中调⽤convertPointAt(column:, row :)。 timedAction(delay :, perform:)的返回值可能为nil。 Guideline对象只有两 ⽅法：combine ithString(options:)跟upvoteBy()。 你不应该直接调⽤数据源⽅法tableView(cellForRowAtIndexPath:)。 类前缀 Swift 中的类型会⾃动加⼊包含它们的模块的命名空间。所以即使是为了最⼩化命名冲 突的可能性，前缀也是不必要的。如果来⾃于不同模块的两个名称冲突了，可以通过 在名称前⾯加上模块名以消除歧义： import MyModule var myClass =