这篇Swift风格指南与你看到的其他的指南有所不同,此篇指南主要焦点集中在打印和Wb展示的可读写上。我们创建此篇风格指南的目的,是为了让我们的图书、教程以及初学者套件中的代码保持优美和一致,即使我们有很多不同的作者共同编写这些图书。
我们的首要目标是一致性,可读性和简洁性。
还在使用Objctiv-C?也可以参考我们的Objctiv-C风格指南(中译版)。
命名(Naming)
使用驼峰式的描述性命名方式,为类,方法,变量等命名。类名的首字母应该大写,而方法和变量的首字母使用小写字符。
推荐做法:
[cpp]viwplaincopy
privatltmaximumWidgtCount=
classWidgtContainr{
varwidgtButton:UIButton
ltwidgtHightPrcntag=0.85
}
不推荐做法:
[cpp]viwplaincopy
ltMAX_WIDGET_COUNT=
classapp_widgtContainr{
varwBut:UIButton
ltwHightPct=0.85
}
对于函数和初始化方法,推荐对所有的参数进行有意义的命名,除非上下文已经非常清楚。如果外部参数命名可以使得函数调用更加可读,也应该把外部参数命名包含在内。
[cpp]viwplaincopy
funcdatFromString(datString:String)-NSDat
funcconvrtPointAt(#column:Int,#row:Int)-CGPoint
functimdAction(#dlay:NSTimIntrval,prformaction:SKAction)-SKAction!
//调用方式如下:
datFromString(-03-14)
convrtPointAt(column:42,row:13)
timdAction(dlay:1.0,prform:somOthrAction)
对于方法来说,参照标准的苹果惯例,方法命名含义要引用到第一个参数:
[cpp]viwplaincopy
classGuidlin{
func