代码规范

  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;
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

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