用途:为 Swift 代码提供一套风格约定,帮助保持格式、命名、代码组织与惯用写法的一致性,适用于编写 Swift 代码时参考。
核心原则:清晰 > 简洁 > 一致;代码应在无警告情况下编译。
命名:类型与协议用 UpperCamelCase,其余用 lowerCamelCase;调用处需清晰;除 URL、ID、UUID 等通用缩写外不使用缩写,如用 configuration、manager、context、description 而非 cfg、mgr、ctx、desc。
黄金路径:左侧留白为正常路径,避免嵌套 if,使用 guard 提前返回。
代码组织:使用 extension 与 MARK 注释分组,例如 // MARK: - UITableViewDataSource。
间距:大括号同行开启、换行关闭;方法间空一行;冒号前无空格、后一个空格。
self:除非编译器要求,否则省略 self,且保持一致。
计算属性:只读时省略 get。
闭包:仅单一闭包参数时使用尾随闭包。
类型推断:清晰时让编译器推断;空集合需类型标注,如 var names: [String] = []。
语法糖:优先使用 [String]、[String: Int]、String? 等写法。
访问控制:优先 private 而非 fileprivate;不写 internal(默认);访问控制符置于最前。
内存管理:闭包中按需使用 [weak self],并用 guard let self else { return }。
注释:解释为什么而非做什么;使用 // 或 ///,避免 /* */;保持更新或删除。
常量:用无 case 的 enum 做命名空间,如 enum Math { static let pi = 3.14159 }。
常见错误:过度缩写、嵌套 guard/if、self 使用不一致、类型名过于笼统(Manager、Handler、Helper、Coordinator)、省略访问控制。
限制:资料未提供安装命令、平台支持、收费方式或具体使用步骤。