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)}

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

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

友情链接更多精彩内容