IOS代码规范

一.整体结构

1.每个组件的包含的模块:主要功能HomeVC,PositionExplainVC等

2.Resource资源文件

3.PublicView,这个组件中小范围几个界面共用的view

4.Pod组件信息

二.主要模块结构:注意:所有类以HK为类名开头+功能类名+类型(例如:ViewController,Model,TableViewCell,ViewModel)

1.采用标准的MVVM模块架构Controller放置视图类

2.Model中放置这个类接口需要用到的模型

3.view放置当前类需要的cell及view登录类

4.ViewModel放置当前类关联的viewModel类

三.代码风格

1.使用运算符(+, -,==, 或->)都需要添加空格

letvalue=1+2

2.方法的左大括号不要另起,并和方法名之间留有空格,注释空格

// function DefinefuncmyFunction{// 处理}

3.判断语句不用加括号

iftypeValue==1{// 处理}

5.在访问枚举类型时,使用更简洁的点语法

enumDirection{casenorthcasesouthcaseeastcasewest}letcurrentDirection=.west

6.添加有必要的注释,尽可能使用Xcode注释快捷键(⌘⌥/)

/// <#Description#>////// - Parameters:/// - tableView: <#tableView description#>/// - section: <#section description#>/// - Returns: <#return value description#>functableView(_tableView:UITableView,numberOfRowsInSection section:Int)->Int{returndataList.count}

7.使用 // MARK: -,按功能、协议、代理等分组

// MARK: - UITableViewDelegate// MARK: - Action// MARK: - Request

8.协议一致性:当对象要实现协议一致性时,推荐使用 extension 隔离协议中的方法集,这样让相关方法和协议集中在一起,方便归类和查找

// MARK: - UICollectionViewDelegate, UICollectionViewDataSourceextensionXMHomeViewController:UICollectionViewDelegate,UICollectionViewDataSource{// 代理方法}// MARK: - HttpsRequestextensionXMHomeViewController{// 网络请求方法}

9.当对外接口不兼容时,使用@available(iOS x.0, *) 标明接口适配的起始系统版本号

@available(iOS8.0,*)funcmyFunction(){//}

四.命名规范

1.常量,变量,函数,方法的命名规则使用小驼峰规则,首字母小写,类型名使用大驼峰规则,首字母大写。

classMyClass:class{letmyImageView:UIImageViewletmyName:String}

2.当命名里出现缩写词时,缩写词要么全部大写,要么全部小写,以首字母大小写为准

lethtmlString="https://www.baidu.com"leturlString:URLStringletuserID:UserIDclassHTMLModel{//}

3.bool类型命名时,使用is作为前缀

varisMine:Bool=false

Swift中类别(类,结构体)在编译时会把模块设置为默认的命名空间,所以不用为了区分类别而添加前缀,比如XYHomeViewController,但是为了和引用的第三方库作区分,建议可以继续使用前缀,以作为规范化处理,结构更清晰。

懒加载用来细致地控制对象的生命周期,这对于想实现延迟加载视图的UIViewController特别有用

// MARK: - 懒加载privatelazyvartableView:UITableView={lettableView=UITableView.init(frame:CGRect.zero,style:.plain)tableView.separatorStyle=.nonetableView.rowHeight=UITableViewAutomaticDimensiontableView.estimatedRowHeight=200tableView.dataSource=selftableView.delegate=selftableView.register(UINib(nibName:homeListCell,bundle:nil),forCellReuseIdentifier:homeListCell)returntableView}()

五.语法规范

1.可选类型拆包取值时,使用if let 判断

ifletdata=result.data{//}

2.多个可选类型拆包取值时,将多个if let 判断合并

ifletname=person.name,letage=person.age{//}

3.尽量不要使用 as! 或 try!,对于可选类型Optional多使用as?,?? 可以给变量设置默认值

// 使用if let as?判断ifletname=person.nameas?String{//}// 给name变量设置默认值varname=person.name??""

4.类型推断:推荐用紧凑方式写代码,让编辑器推断实例中常量和变量的类型。类型推断也适用于小型非空数组/字典。如有需要,请指定特定类型,例如:CGFloat或者Int16等。

// 推荐写法letmessage="Click the button"letcurrentBounds=computeViewBounds()varnames=["Mic","Sam","Christine"]letmaximumWidth:CGFloat=106.5// 不推荐写法letmessage:String="Click the button"letcurrentBounds:CGRect=computeViewBounds()varnames:[String]=["Mic","Sam","Christine"]

针对空数组和空字典的类型推断写法,推荐使用类型注释。此准则也意味着选择描述性名称比以前更加重要。

// 推荐写法varnames:[String]=[]varlookup:[String:Int]=[:]// 不推荐写法varnames=[String]()varlookup=[String:Int]()

5.常量定义,建议尽可能定义在类型里面,避免污染全局命名空间,如果是其他地方有可能复用的cell可以定义在类型外面

staticlethomeListCell="HomeListCell"classHomeListCell:UITableViewCell{staticletkHomeCellHeight=80.0//}

6.最短路径规则:当编码遇到条件判断时,左边的距离是黄金路径或幸福路径,因为路径越短,速度越快。guard 就为此而生的。

funclogin(with username:String?,password:String?)throws->LoginError{guardletusername=usernameelse{throw.noUsername}guardletpassword=passwordelse{throw.noPassword}// 处理登录}

7.循环遍历使用for-in表达式

// 循环for_in0..<list.count{print("items")}// 遍历for(index,person)inpersonList.enumerate(){print("\(person)is at position #\(index)")}// 间隔2位循环forindexin0.stride(from:0,to:items.count,by:2){print(index)}// 翻转forindexin(0...3).reversed(){print(index)}

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

推荐阅读更多精彩内容

  • iOS Swift 代码规范 编码格式 使用二元运算符(+, -,==, 或->)的前后都需要添加空格 let v...
    我会回来的阅读 452评论 0 0
  • 前言 关于代码规范的重要性这里不做过多解释,能看到这篇文章说明你已经开始重视代码规范了(代码规范看起来是在限制你的...
    iOS鑫阅读 988评论 1 10
  • 修订历史 版本号修改内容修改日期修改人 说明 本文将以条款的形式逐条说明每个规范,每个条款会标记[强制]、[推荐]...
    比特_0bd7阅读 674评论 0 0
  • 一、命名规范 1、统一要求含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释,使用全称,不使用缩写。 ...
    Untils阅读 560评论 0 0
  • 一) 关于命名 1> 统一要求含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释; 使用全称,不适用缩...
    奋斗的老王阅读 545评论 0 51