制定自己的Swift编码规范

警告

尽量将所有警告都处理掉。

命名

1.使用具有描述性的名称,
2.使用驼峰式命名规则给类方法和变量等命名。
3.类别名称(类,结构体,枚举和协议)首字母大写,方法或者变量的首字母小写。

// 常量
private let maximumWidgetCount = 100

// 方法
func setupWidget() ->{
    print("ok")
}

// 类
class WidgetContainer {
    var widgetButton: UIButton  
    let  widgetHeightPercentage = 0.85
}

缩进

1.使用四个空格进行缩进
2.每行最多160个字符,这样可以避免一行过长。
3.确保每个文件结尾都有空白行。
4.代码结尾不要使用分号;
5.在逗号后面加一个空格

let numberArray = [1, 3, 6, 10]

6.不要使用 as! 或 try!
推荐

// 使用if let as?判断
if let text = text as? String {
    /* ... */
}

// 使用if let try 或者 try?
if let test = try aTryFuncton() {
    /* ... */
}

Closure Expressions(闭包表达式)
闭包放在最后面

// Preferred(推荐)
UIView.animateWithDuration(1.0) {
  self.myView.alpha = 0
}

UIView.animateWithDuration(1.0,
  animations: {
    self.myView.alpha = 0
  },
  completion: { finished in
    self.myView.removeFromSuperview()
  }
)

// Not Preferred(不推荐)
UIView.animateWithDuration(1.0, animations: {
  self.myView.alpha = 0
})

UIView.animateWithDuration(1.0,
  animations: {
    self.myView.alpha = 0
  }) { f in
    self.myView.removeFromSuperview()
}

7.命名应该具有描述性 和 清晰的。
不要缩写,简写命名,或用单个字母命名。
如果原有命名不能明显表明类型,则属性命名内要包括类型信息。

// 推荐
class RoundAnimatingButton: UIButton { /* ... */ }
// 不推荐
class CustomButton: UIButton { /* ... */ }

// 推荐
class ConnectionTableViewCell: UITableViewCell {
    //这个不是 UIImage, 不应该以Image 为结尾命名。
    ✅let personImageView: UIImageView
    ❌let personImage: UIImageView 
   
    // 建议使用 animationDuration 或 animationTimeInterval
    ✅let animationDuration: NSTimeInterval
    ❌let animation: NSTimeInterval

    // transition 不能清晰表达出是String
    ✅let transitionText: String
    ✅let transitionString: String
    ❌let transition: String

    // 作为属性名的firstName,很明显是字符串类型,所以不用在命名里不用包含String
    ✅let firstName: String
    ✅let firstNameLabel: UILabel

    // 因用snapkit来布局,页面默认都是ViewController, 所以这个简化
    ✅let testController: UIViewController

    // 当使用outlets时, 确保命名中标注类型。为了保持一致性,建议把类型放到变量的结尾,而不是开始,如submitButton
    ✅@IBOutlet weak var submitButton: UIButton!
    ✅@IBOutlet weak var emailTextField: UITextField!
    ✅@IBOutlet weak var nameLabel: UILabel!

    // 常量统一用全大写,下划线连线
    enum Dict: String {
        case AAA_BBB
        case CCC_DDD
    }

    // Localizable.strings
    "ALERT_TITLE" = "测试";
    "ALERT_CONTENT_UNLOGIN" = "请登录";
    "ALERT_ACTION_OK" = "好的";
    "ALERT_ACTION_CANCEL" = "取消";
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,542评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,596评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,021评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,682评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,792评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,985评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,107评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,845评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,299评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,441评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,072评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2 350

推荐阅读更多精彩内容