Swift编程风格指南

这个风格指南可能和你从其他地方看到的不同，我们的焦点主要集中在互联网和文章上的可读性，创建这个编程风格指南是为了保持我们的书籍、教程和入门工具包中代码的优雅与一致性——尽管我们有和许多不同的作者合作。

我们的首要目的是简洁、可读性和简单。

命名

对类、方法、变量等使用包含描述性的驼峰式（CamelCase）命名。类名和全局常量的所有首字母大写，方法和变量名开始第一个字母小写。

建议：

1 2 3 4 5 6

let MaximumWidgetCount = 100                class WidgetContainer {           var widgetButton : UIButton          let widgetHeightPercentage = 0.85         }

不建议：

C++

1 2 3 4 5 6

let MAX_WIDGET_COUNT = 100                class app_widgetContainer {           var wBut : UIButton          let wHeightPct = 0.85         }

对于函数和init方法，所有的参数都要拥有一个有着良好命名的参数名，除非上下文已经很清晰了。如果在外部调用函数的时候包含了参数名，将会使函数调用更加易读：

1 2 3 4 5 6 7 8

func dateFromString ( dateString : NSString ) - &gt ; NSDate        func convertPointAt ( column : Int , row : Int ) - &gt ; CGPoint        func timedAction ( delay : NSTimeInterval , perform action : SKAction ) - &gt ; SKAction !                // would be called like this:        dateFromString ( "2014-03-14" )         convertPointAt ( column : 42 , row : 13 )         timedAction ( delay : 1.0 , perform : someOtherAction )

对于方法而言，按照Apple的习惯，在方法名里引用第一个参数：

1 2 3 4

class Guideline {           func combineWithString ( incoming : String , options : Dictionary ? ) { . . . }           func upvoteBy ( amount : Int ) { . . . }         }

当我们在文章中需要引用方法的地方，要从调用者的角度包含所有必须的参数名。如果上下文很清晰，而且准确的方法签名不重要时，你就能只使用方法名。

从你自己的init方法实现中调用convertPointAt(column:row:)。

如果你实现了didSelectRowAtIndexPath，那么记得在你完成工作后取消选择行。

你不能直接调用dataSource的tableView(_:cellForRowAtIndexPath:) 。

类前缀

Swift的类型都自动的有其模块的命名空间，其结果是不用为了减少名称冲突而必须使用前缀。如果有两个来自于不同模块的名称起了冲突，你可以通过在类型名称前加上模块名来消除两者间的歧义：

C++

1 2 3 4 5 6

let MAX_WIDGET_COUNT = 100                class app_widgetContainer {           var wBut : UIButton          let wHeightPct = 0.85         }

对于函数和init方法，所有的参数都要拥有一个有着良好命名的参数名，除非上下文已经很清晰了。如果在外部调用函数的时候包含了参数名，将会使函数调用更加易读：

1 2 3 4 5 6 7 8

func dateFromString ( dateString : NSString ) - &gt ; NSDate        func convertPointAt ( column : Int , row : Int ) - &gt ; CGPoint        func timedAction ( delay : NSTimeInterval , perform action : SKAction ) - &gt ; SKAction !                // would be called like this:        dateFromString ( "2014-03-14" )         convertPointAt ( column : 42 , row : 13 )         timedAction ( delay : 1.0 , perform : someOtherAction )

对于方法而言，按照Apple的习惯，在方法名里引用第一个参数：

1 2 3 4

class Guideline {           func combineWithString ( incoming : String , options : Dictionary ? ) { . . . }           func upvoteBy ( amount : Int ) { . . . }         }

当我们在文章中需要引用方法的地方，要从调用者的角度包含所有必须的参数名。如果上下文很清晰，而且准确的方法签名不重要时，你就能只使用方法名。

从你自己的init方法实现中调用convertPointAt(column:row:)。

如果你实现了didSelectRowAtIndexPath，那么记得在你完成工作后取消选择行。

你不能直接调用dataSource的tableView(_:cellForRowAtIndexPath:) 。

类前缀

Swift的类型都自动的有其模块的命名空间，其结果是不用为了减少名称冲突而必须使用前缀。如果有两个来自于不同模块的名称起了冲突，你可以通过在类型名称前加上模块名来消除两者间的歧义：