首先推荐阅读下:Apple's API Design Guidelines




0、目录 Table Of Contents

1. Code Formatting

2. Naming

3. Coding Style

  • 3.1 General
  • 3.2 Access Modifiers
  • 3.3 Custom Operators
  • 3.4 Switch Statements and enums
  • 3.5 Optionals
  • 3.6 Protocols
  • 3.7 Properties
  • 3.8 Closures
  • 3.9 Arrays
  • 3.10 Error Handling
  • 3.11 Using guard Statements


4. Documentation/Comments

  • 4.1 Documentation
  • 4.2 Other Commenting Guidelines



来自Linkedin的Swift编程风格指南 LinkedIn Swift Style Guide

来自Linkedin的Swift编程风格指南 LinkedIn Swift Style Guide - 敏捷大拇指 - 来自Linkedin的Swift编程风格指南 LinkedIn Swift Style Guide





1、Code Formatting 代码格式化

1.1 使用4个空格来代替Tabs

1.2 避免过长的行,可以在XCode中进行设置单行最大长度:(Xcode->Preferences->Text Editing->Page guide at column: 160 is helpful for this)

1.3 保证每个文件结尾都存在一个新行 Ensure that there is a newline at the end of every file.

1.4 避免无意义的尾随空格: (Xcode->Preferences->Text Editing->Automatically trim trailing whitespace + Including whitespace-only lines).

1.5 避免将单独的左花括号放置到一行,我们参考了:1TBS style

[Swift] 纯文本查看 复制代码
class SomeClass {
    func someMethod() {
        if x == y {
            /* ... */
        } else if x == z {
            /* ... */
        } else {
            /* ... */
        }
    }
    /* ... */
}


1.6 在写变量的类型声明、字典类型的键、函数参数、协议的声明或者父类的时候,不要在冒号前添加空格。

[Swift] 纯文本查看 复制代码
// specifying type
let pirateViewController: PirateViewController
// dictionary syntax (note that we left-align as opposed to aligning colons)
let ninjaDicti