iOS 编码规范和编码习惯

  • 使用4个空格进行缩进。(可在Xcode的Preferences中进行设置)
  • 左大括号写在首行。eg:
class TestClass {
    /* ... */
}
  • 二元运算符前后添加空格。eg:
let testValue = 1 + 2
  • 添加有必要的注释(使用Xcode注释快捷键)。eg:
// 测试按钮
var testBtn:UIButton
/// <#Description#>
///
/// - Parameter testValue: <#testValue description#>
/// - Returns: <#return value description#>
func testFunction(testValue: Int) -> Int {
    /*...*/
}
  • 图片命名要清晰。eg:


    与功能相对应命名图片
  • 变量命名应该能推断出该变量类型,或以变量类型结尾。eg:
let coverImageView: UIImageView
let firstName: String
  • 接口命名与后台所提供的保持一直,由请求路径、接口名和请求后缀组成。 eg:


    GetVipColors接口.jpg
  • 接口的请求建议一次封装多处使用,尤其是像获取用户信息这种。eg:


    对GetVipColors接口的封装.jpg
  • 类型多时使用枚举,枚举名字和功能对应 eg:
/// 房间类型
///
/// - common: 普通模式
/// - handPattern: 相亲
/// - pkPattern: 团战
enum RoomShowType:String {
    case common = "common"
    case handPattern = "hand_pattern"
    case pkPattern = "pk_pattern"
}
  • 可选型使用guard或者if let解包后使用。eg:
// guard 解包
guard let giftView = giftViewArr[toMicId] else {return}
// if let 解包
if let giftView = giftViewArr[toMicId] {
}
// if let 解包多个
if let subview = subview, let volume = volume {
}
  • block的执行如果存在延迟,需要用weak来规避强引用。 eg:
DispatchQueue.main.asyncAfter(deadline: .now() + 2) { [weak self] in
    if let weakself = self{
        weakself.rainLayer.birthRate = 0
    }
}
  • 使用// MARK: - XXX进行分组。eg:
/// MARK: - System
// MARK: - Public
// MARK: - Action
// MARK: - Private
// MARK: - xxxDelegate
  • 控制代码段大小(比如有一个100行的代码块,其中50行代码是实现了某个动画,则把这50行代码封装为另一个代码块)
  • 较大功能或逻辑的修改,最好标记一下。eg:
// modified by FangLin 2018-01-01
  • 在取可变数组中的元素时,要考虑数组越界的情况。
  • 修改后的代码要进行编译验证。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,192评论 6 511
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,858评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,517评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,148评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,162评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,905评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,537评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,439评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,956评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,083评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,218评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,899评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,565评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,093评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,201评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,539评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,215评论 2 358

推荐阅读更多精彩内容

  • 1、通过CocoaPods安装项目名称项目信息 AFNetworking网络请求组件 FMDB本地数据库组件 SD...
    阳明先生_X自主阅读 15,982评论 3 119
  • “再超凡脱俗的人也离不开柴米油盐,因为风花雪月吃不饱。” ​​​ 想了想为什么想要写流水账一般细碎无章的日记,而...
    不吃鱼的小多肉阅读 229评论 0 0
  • 这几天我读了几位作者的文章之后,发现了自己很多的不足。在这里不想过多赘述。 真是无知者无畏啊!我竟能无视自己的浅显...
    高楼独倚阅读 335评论 9 8
  • 1
    壬几A阅读 66评论 0 0
  • 2017.8.30今天犹豫我妈身体不舒服,我把瑜珊送去我就回妈家了,回家整整一天,中午放学她跟爸爸一起吃的饭。晚上...
    瑜珊妈妈阅读 184评论 0 0