注释规范
- 设计描述使用多行注释
/***/ - 文本注释使用
/// - 需要对方法参数或返回值做说明时使用
option+command+/注释 - 同一个文件有多个逻辑块使用
MAEK: -注释
命名规范
- UpperCamelCase：文件名、类名（
class）、结构体名（struct）、枚举名（enum）、协议名（protocol）使用大驼峰命名法
. class Student {}
. struct Array {}
. enum Week {}
. protocol Networkable {}
- lowerCamelCase：方法名、参数名、成员变量、局部变量、枚举值使用小驼峰命名法
/// 类名Student 遵循大驼峰命名法
class Student {
/// 枚举名Week 遵循大驼峰命名法
enum Week {
/// 枚举值周一到周日 遵循小驼峰命名法
case monday
case tuesday
case wednesday
case thursday
case friday
case saturday
case sunday
}
/// 属性是否要去上学 遵循小驼峰命名法
var isGoSchool: Bool?
/// 实现一个方法传输一个日期(周几)判断是否需要去学校
/// goSchool：方法名 遵循小驼峰命名法
///
/// - Parameter week: 传入的日期参数 遵循小驼峰命名法
func goSchool(of week: Week) {
switch week {
case .saturday, .sunday:
isGoSchool = false
default:
isGoSchool = true
}
}
}
- 全局常量命名使用 k 前缀 + UpperCamelCase 命名
/// 屏幕宽度
let kWidth = UIScreen.main.bounds.width
- 扩展文件，用“原始类型名＋扩展名”作为扩展文件名，其中原始类型名及扩展名也使用 UpperCamelCase
/// 给UIImageView扩展加载网络图片的能力
UIImageView+Kingfisher.swift
- 不要使用单词拼音混合命名
///错误示例
func openWenJian() {}
///正确示例
func openFile() {}
- 缩写不要缩写，若缩写全大写 eg.
URL、JSON
格式规范
类、函数左大括号不另起一行，与名称之间留有空格
禁止使用无用分号
-
代码中的空格出现地点
. 注释符号与注释内容之间有空格
. 类继承时, 参数名和类型之间等, 冒号前面不加空格, 但后面跟空格
. 任何运算符前后有空格
. 表示返回值的 -> 两边
. 参数列表、数组、tuple、字典里的逗号后面有一个空格
WeChat882d4d42d5286671e899a6d7a33cee69.png
方法之间空一行
重载的声明放在一起，按照参数的多少从少到多向下排列
每一行只声明一个变量
表示单例的静态属性，一般命名为 shared
/// 创建网络请求单例
class FSHttpRequest: NSObject {
static let shared = FSHttpRequest()
private override init() {}
}
- 解包时推荐使用原有名字
var count: Int?
if let count = count {}
// or
guard let count = count else { return }
- 实现每个协议时, 在单独的 extension 里来实现
// MARK: - UITableViewDataSource
extension FSViewController:UITableViewDelegate{
func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
}
}
// MARK: - UITableViewDelegate
extension FSViewController:UITableViewDataSource{
func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
return 1
}
func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
let cell = tableView.dequeueReusableCell(withIdentifier: String(describing: UITableViewCell.self), for: indexPath)
return cell
}
}
简洁原则
- 类及结构体初始化方法不要直接调用.init，直接直接省略，使用()
不建议
let student = Student.init()
建议
let student = Student()
- 如果只有一个 get 的计算属性，忽略 get
///不建议
var baseURL: String! {
get {
return "https://baidu.com"
}
}
///建议
var baseURL: String! {
return "https://baidu.com"
}
- 数据定义时，尽量使用字面量形式进行自动推断，如果上下文不足以推断字面量类型时，需要声明赋值类型
///不建议
let age:Int = 18
///建议
let age = 18
- 集合类型数据进行过滤, 转换等, 优先使用
filter,map等高阶函数简化代码，并尽量使用最简写
let array = [1,2,nil,4,5,nil,2,3,nil]
/// 1.去掉为空的元素
/// 2.元素+2
/// 3.过滤掉非偶数
let newArray = array.compactMap {$0}.map {$0 + 2}.filter {$0%2 == 0}
参考 https://blog.csdn.net/li_tianxng/article/details/120122977
