Linkedin Swift Style Guide

这是 Linkedin Swift 的代码规范,我挑出了我懂的地方进行翻译。
原文

代码格式

  1. 一个 tab 四行
  2. 一行别超过 160 个字符
  3. 确保每个文件的末尾都有换行符
  4. 确保任何地方的尾部没有空格
  5. 不要另起一行放开口括号
  6. 当在声明一个属性,常量,字典的 key ,函数参数,或者遵循一个协议,继承某个父类,冒号前面别加空格
  7. 一般来说,逗号后面要有一个空格符
  8. 二元操作符前后应该有空格,但是 ( 后面和 ) 前面不应该有空格
  9. 遵循 Xcode 的对齐方式。当声明一个跨越多行的函数的时候,最好用 Xcode 7.3 的对齐方式
  10. 当在调用一个有许多参数的函数的时候,每个参数一行并加额外的缩进
  11. 当在处理一个大的,大到你必须要分行写这个数组或者字典的时候,[] 的写法应该跟 () 在 if 语句中的写法一样
  12. 尽量避免多行的谓词

命名

  1. 不要使用 OC 式的前缀
  2. 类型名开头大写
  3. 其他的一般开头小写
  4. 当在处理缩略词或者全大写的名词,一般来说在代码中还是全大写,除非这个词你要放在开头,这样你每个字母都小写
  5. 所有的常量除了单例对象都应该是 static。所有的 static 的 constants 应该放在 enum 的容器内。enum 的命名必须是单数形式的,并且命名可以很明显的让人看出这是一个常量的容器。如果取不出一个好名字,就在名字后面加上 Constant.
  6. 命名不要使用缩略名
  7. 当变量或者常量的命名不能容易的看出类型信息的时候,加上类型信息

代码风格

  1. 尽量使用 let 而不是 var
  2. 尽量使用 map, filter, reduce 的组合
  3. 如果常量或者变量可以被编译器推断出类型,就不要写类型名
  4. 如果想一个函数返回多个值,尽量使用 tuple 而不是使用 inout 参数,并且最好使用带 labeled tuple。如果使用某一 tuple 多次,考虑使用 typelias。如果返回的 tuple 包含3个或者3个以上的值,考虑用 struct 或者 类
  5. 调用类方法,带上类名
  6. 当在写 methods 的时候,随时想着这个method 是否会被重写,如果不会 mark final。final methods 可以缩短编译的时间
  7. 当在声明函数和属性的时候,尽量用 static 而不是 class,因为用 static 声明的无法被重写,但是如果你想在子类重写你的 type property 或者 type function 考虑用 protocol
  8. 如果你的函数不需要参数,没什么副作用,只是用来返回一些的值的,最好用计算属性替代

修饰符访问

  1. access modifier keyword 写在最前面
  2. 尽量用 private 而不是 fileprivate

自定义操作符

  1. 最好用函数替代自定义操作符

Switch 语句和 enum

  1. 在使用 switch 语句的时候,如果所有的可能性是可以枚举完的,不要使用 default 语句,unuse case 用 break
  2. 如果你的 default 不应该被 reach 到,你应该 throw 一个 error

可选值

  1. 只有在 @IBOutlet 情况下才使用 ! 隐式解包
  2. 不要使用 as! or try!
  3. 不要使用 unowned
  4. 当对一个可选值解包的时候,尽量用同样的名字

协议

  1. 当实现协议的时候,用 //MARK:: 或者 extension

属性

  1. willSet/didSet 就使用默认的 newValue 和 oldvalue 就好了

闭包

  1. 如果闭包参数很明显,省略类型名是OK的,但是你写出来也没问题,可读性是最重要的
  2. 如果一个参数类型是一个闭包,除非有必要,该类型不需要用括号扩起来

数组

  1. 一般情况,避免直接通过数组下标去访问数组元素
  2. 不要使用 += or + 操作符来操作数组,使用 .append() 或者 .append(contentsOf:),因为后者有更好的性能, 像这种 let myNewArray = arr1 + arr2 可以用 let myNewArray = [arr1, arr2].joined()

错误处理

  1. 一般来说,如果一个方法可能会失败,使用可选值会使得错误不那么明显,那就用 try catch 吧。提供了一种自定义错误的构造
struct Error: Swift.Error {
    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
    }
}

使用 guard 语句

  1. 我们采用遇到错误尽早退出的原则,在选择 if 还是 guard 的时候,最重要的是代码的可读性和减少 if - else 嵌套

文档/Comments

  1. 如果一个 function 的事件复杂度大于 O(1),你应该增加一个 doc comment。如果代码里加了一些非常 tricky 的技巧,应该记录在文档内。复杂的类,结构体,协议,枚举,属性都要写文档
  2. 看 Swift 的 Markup Comment Markup 链接
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容