swift命名规范

1.指导方针：

为了让代码更通熟易懂，符合大多数程序员的阅读使用习惯，所以总结一下相关命名规范

以下命名规范包含：

命名分类
访问权限
注释

2. 命名分类

在项目中，大多数地方使用驼峰式命名，类，结构体，枚举，协议，需要附加前缀，以下示例均使用NY作为前缀

2.1 类名class/结构体struct
2.2 方法名function
2.3 变量variable
2.4 常量constant
2.5 枚举enum
2.6 协议protocol
2.7 闭包closure
2.8 泛型temple

2.1 类名class/结构体struct

class  NYPepple: NSObject {
    var name: String? 
    var age: Int?
    let color: UIColor?
}

struct NYWeather {
    var temperature: CGFloat = 0
    var windLevel: Int = 1
}

struct NYLocation {
    var longitude: CGFloat = 0
    var latitude: CGFloat = 0
}

2.2 方法名function


func deal(with people: NYPepple, at location: NYLocation) {

}

2.3 变量variable

变量命名，采取功能属性特性+变量类型全称的形式，请避免使用缩写的形式
正确写法

var people: NYPeople = .init()
var nameLabel: UIlabel = .init()
var passwordTextField: UITextField = .init()
var dealViewController: UIViewController = .init()

错误写法

var p: = NYPeople.init()
var nameL = UIlabel.init()
var passwordTF = UITextField.init()
var dealVC = UIViewController()

2.4 常量constant

let weather: NYWeather = .init()

2.5 枚举enum

enum NYWeatherStyle {
    case sunny
    case cloudy
    case windy
}

2.6 协议protocol

protocol NYCheckWeatherProtocol: NSObjectProtocol {
    func ny_checkWeather(weather: NYWeather, location: NYLocation)
}

2.7 闭包closure

typealias NYActionClosure = (_ item1: String, _ item2: String)->Void
func showWeather(with actionClosure: NYActionClosure) {
}

2.8 泛型temple

泛型通常使用全大写表示

class NYSon: NYFather {
    func print(model: MODEL) {
        print(model)
    }
}

3 权限控制

在swift默认都是internal类型

- open: 可以在任何地方访问，包括override和继承。
- public: 可以在任何地方访问，但其他module中不可以被override和继承，而在本module内可以被override和继承。
- internal: 新建文件时默认为internal，所修饰的属性或方法在整个模块内都可以访问。
- fileprivate: 在当前文件内可以被访问，在子类中能访问。
- private: 在当前类中能被访问，在子类中不能访问。

在涉及到需要外部访问的领域，我们默认所有类的变量都为private，需要对外公开的属性设置为private(set)，需要修改类内部属性时，通过对外公开的方法修改（遵循接口开闭的设计原则）以下为示例代码：

class NYSon: NSObject {
    private(set) var name: String
    private(set) var age: Int
    init(name: String, age: Int) {
      super.init()
      self.name = name
      self.age = age
    }
    // 长大1岁
    func grow() {
      age += 1
    }
}
var son: NYSon = .init(name: "little Jhon", age: 12)
son.grow()    //长大一岁
print(son.age)  //输出12岁

/**
修改son对象的属性，仅可以通过类提供的方法去修改，请勿使用
son.age = 12
的方式
*/

4 注释

注释使用苹果推荐的注释格式, 快捷键option + command + / (⌥ + ⌘ + /)