代码规范

  1. 代码分四种类型:赋值语句,循环语句,判断语句,控制语句。

  2. 每种代码间需要一个空行分开,如果严格按照要求做,代码块思维会很容易形成。(重要规范)

  3. 两元远算符之间需要空格分开:如等号,let a = 1(重要规范)

  4. 大括号的位置:苹果官方大括号是跟在方法后面(重要规范) ,如:

public func abc() {
    xxxxx;
    xxxxx;
}
  1. 声明变量不要一行多个,应该分成多行写:如int a, b, c应该写成
let a = 0
let b = 1
var c = ""
  1. 逗号,冒号后面需要有个空格:如(JSON)
func centralManager(_ central: CBCentralManager, didDiscover peripheral: CBPeripheral, advertisementData: [String : Any], rssi RSSI: NSNumber) {
}
  1. 每个方法间至少需要一个空行。

  2. 循环语句和判断语句内容为一句时依然需要大括号,为了方便以后扩展,方便自己和他人查看,维护。

  3. 一个方法体最好不要超过一个屏幕(大概25行),如果实在没办法要超过则需要很明确的代码注释。(可参考10点的做法)

  4. 写步骤类的代码注释最好加上步骤说明。如:

// 1.找到对应model
xxxxxxxxx

// 2.改变xx属性值
xxxxxxxxx

// 3.提交到服务器
xxxxxxxx
  1. 重要业务方法需要加注释(重要规范),如:
/// 注释测试的方法(针对swift)
///
/// - Parameters:
///   - sender: 触摸对象
///   - other: 其他参数
/// - Returns: int类型数据
public func abc:(sender: UIButton, other: String) -> Int {

}
  1. 消除警告提高编译速度

  2. 没用的代码都删除掉。(因为如果是有历史性的代码在git是保存的了)

  3. if else 按照官方的格式书写:(两端都应该这样写)

if (a == b) {
    xxxx
} else if (a != b) {
    xxxx
} else {
    xxxx
}
  1. 每个类头都需要注释,该文件的主要用途或者类的解释

  2. 代码规范举例

if (a == b) {
    xxxx

    for (xxx; xxx; xxx) {
        xxxx;
    }

    xxxx
} else if (a != b) {
    for (xxx; xxx; xxx) {
        if (xxx) {
                xxxxx;
        }
    }
} else {
    for (xxx; xxx; xxx) {
        xxxx;
        
        break;
    }

    for (xxx; xxx; xxx) {
        xxxx;
        
        return;
    }
}

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

推荐阅读更多精彩内容

  • [TOC] 前言 这份文档是Google Java编程风格规范的完整定义。当且仅当一个Java源文件符合此文档中的...
    marine8888阅读 1,942评论 0 1
  • 在日常的开发过程中,如果大家都遵循统一的代码规范,我们就可以避免许多无缘无故的Bug,提高程序的准确性、连续性、可...
    xqqlv阅读 1,168评论 0 1
  • 注: Copy 自 cocoachina 英文原文:Swift Style Guide 翻译作者:码农网 – 豆照...
    Mid_Chan阅读 697评论 0 0
  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,435评论 21 35
  • 我有两个爸爸,一个是受过良好教育在政府部门身居要职的穷爸爸,一个是没上过大学却财务自由的富爸爸。是的,看到这样的开...
    鱿鱼没有鱼阅读 381评论 0 1