代码规范

2017-08-29  本文已影响0人  双鲶鱼

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

2.每种代码间需要一个空行分开。(重要规范)

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

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

public func abc() {
    xxxxx;
    xxxxx;
}

5.声明变量不要一行多个,应该分成多行写:如int a, b, c应该写成

let a = 0
let b = 1
var c = ""

6.逗号,冒号后面需要有个空格:如(JSON)

func centralManager(_ central: CBCentralManager, didDiscover peripheral: CBPeripheral, advertisementData: [String : Any], rssi RSSI: NSNumber) {
}

7.每个方法间至少需要一个空行。

8.委托代码加上#pragma mark - 如:(iOS)
// MARK: - UICollectionViewDataSource, UICollectionViewDelegate
委托名要全名,这也可以用command+鼠标左键可以跳转到说明处,而且前后需要空一行空行

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

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

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

// 1.找到对应model
xxxxxxxxx

// 2.改变xx属性值
xxxxxxxxx

// 3.提交到服务器

12.重要业务方法需要加注释(重要规范),如:

/// 注释测试的方法(针对swift)
///
/// - Parameters:
///   - sender: 触摸对象
///   - other: 其他参数
/// - Returns: int类型数据
public func abc:(sender: UIButton, other: String) -> Int {

}

13.消除警告提高编译速度

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

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

if (a == b) {
    xxxx
} else if (a != b) {
    xxxx
} else {
    xxxx
}

16.视图以View结尾,控制器以ViewController结尾,TableViewCell以Cell结尾,CollectionViewCell以CollectionCell结尾,实体类以Model结尾(iOS)

17.实体类以Bean结尾(Android)

  1. 每个类头都需要注释,该文件的主要用途或者类的解释

19.举例

if (a == b) {
    xxxx

    for (xxx; xxx; xxx) {
    }

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

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

return xxx;
上一篇 下一篇

猜你喜欢

热点阅读