这篇Swift风格指南与你看到的其他的指南有所不同,此篇指南主要焦点集中在打印和web展示的可读写上。我们创建此篇风格指南的目的,是为了让我们的图书,教程以及初学者套件中的代码保持优美和一致,即使我们有很多不同的作者共同编写这些图书。

我们的首要目标是一致性,可读性和简洁性。

命名(Naming)

使用驼峰式的描述性命名方式,为类,方法,变量等命名。类名的首字母应该大写,而方法和变量的首字母使用小写字符。

推荐做法:

1
2
3
4
5
6
private let maximumWidgetCount = 100

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

不推荐做法:

1
2
3
4
5
6
let MAX_WIDGET_COUNT = 100

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

对于函数和初始化方法,推荐对所有的参数进行有意义的命名,除非上下文已经非常清楚。如果外部参数命名可以使得函数调用更加可读,也应该把外部参数命名包含在内。

1
2
3
4
5
6
7
8
func dateFromString(dateString: String) -> NSDate
func convertPointAt(#column: Int,#row: Int) -> CGPoint
func timedAction(#delay: NSTimeInterval,perform action: SKAction) -> SKAction!

// 调用方式如下:
dateFromString("2014-03-14")
convertPointAt(column: 42,row: 13)
timedAction(delay: 1.0,perform: someOtherAction)

对于方法来说,参照标准的苹果惯例,方法命名含义要引用到第一个参数:

1
2
3
4
class Guideline {
func combineWithString(incoming: String,options: Dictionary?) { ... }
func upVoteBy(amount: Int) { ... }
}

枚举(Enumerations)

使用首字母大写的驼峰命名规则来命名枚举值:

1
2
3
4
5
6
enum Shape {
case Rectangle
case Square
case Triangle
case Circle
}

文章(Prose)

当我们在文章中(教程,图书,注释等)需要引用到函数时,需要从调用者的视角考虑,包含必要的参数命名,或者使用_表示不需要命名的参数。

从你自身实现的init中调用convertPointAt(column:row:)

如果你调用dateFromString(_:),需要保证你提供的输入字符串格式是”yyyy-MM-dd”。

如果你需要在viewDidLoad()中调用timedAction(delay:perform:),记得提供调整后的延迟值和需要处理的动作。

你不能直接调用数据源方法tableView(_:cellForRowAtIndexPath:)

当你遇到疑问时,可以看看Xcode在jump bar中是如何列出方法名的 —— 我们的风格与此匹配。

Methods in Xcode jump bar

类的前缀(Class Prefixes)

Swift类型自动被模块名设置了名称空间,所以你不需要加一个类的前缀。如果两个来自不同模块的命名冲突了,你可以附加一个模块名到类型命名的前面来消除冲突。

1
2
3
import SomeModule

let myClass = MyModule.UsefulClass()

空格(Spacing)

  • 使用2个空格的缩进比使用tabs更好,可以减少占用空间和帮助防止多次换行。确保在Xcode进行了下图的偏好设置:

Xcode indent settings

  • 方法定义的大括号或者其他大括号(if/else/switch/while等)—— 般都放在定义名称的同一行,并且使用一个新的行来结束。

  • 提示:你可以通过以下方法重新进行缩进:选择一些代码(或者使用⌘A选择所有),然后按Control-I(或者点击菜单栏 Editor\Structure\Re-Indent)。一些Xcode模板代码使用的缩进是4个空格,所以这种方法可以很好的修复缩进。

推荐做法:

1
2
3
4
5
if user.isHappy {
// Do something
} else {
// Do something else
}

不推荐做法:

1
2
3
4
5
6
7
if user.isHappy
{
// Do something
}
else {
// Do something else
}
  • 应该在方法之间空出一行,从视觉上有更好的区分和组织。方法内的空白行隔开不同的功能,但是当一个方法中有很多段落时,也意味着你应该将该方法重构成几个方法。

注释(Comments)

当你需要时,使用注释来解释一段特定的代码段的作用。注释必须保证更新或者及时删除。

避免在代码中使用块注释,代码尽可能自己能表达含义。以下情况除外:当使用注释来生成文档时。

类和结构体(Classes and Structures)

选择使用谁?(Which one to use?)

请记住,结构体是值类型。使用结构体并没有一个标识。一个数组包含[a,b,c]和另外一个数组同样包含[a,c]是完全一样的,它们完全可以交换使用。使用第一个还是使用第二个无关紧要,因为它们代表的是同一个东西。这就是为什么数组是结构体。

类是引用类型。使用类是有一个标识或者有一个特定的生命周期。你需要对一个人类建模为一个类,因为两个不同的人的实例,是两个不同的东西。只是因为两个人有同样的名字和生日,也不能断定这两个人是一样的。但是人的生日是一个结构体,因为日期1950-3-3和另外一个日期1950-3-3是相同的。日期不需要一个标识。

有时,一些事物应该定义为结构体,但是需要兼容AnyObject或者已经在以前的历史版本中定义为类(NSDateNSSet)。尽可能的尝试遵守这些规则。

定义的案例(Example deFinition)

以下是一个风格很好的类定义:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class Circle: Shape {
var x: Int,y: Int
var radius: Double
var diameter: Double {
get {
return radius * 2
}
set {
radius = newValue / 2
}
}

init(x: Int,y: Int,radius: Double) {
self.x = x
self.y = y
self.radius = radius
}

convenience init(x: Int,diameter: Double) {
self.init(x: x,y: y,radius: diameter / 2)
}

func describe() -> String {
return "I am a circle at \(centerString()) with an area of \(computeArea())"
}

override func computeArea() -> Double {
return M_PI * radius * radius
}

private func centerString() -> String {
return "(\(x),\(y))"
}
}

以上例子遵循了以下风格规范:

  • 指定属性,变量,常量,参数定义或者其他定义的类型,在冒号后面,紧跟着一个空格,而不是把空格放在冒号前面。比如:x: IntCircle: Shape
  • 如果能表示相同的目的和上下文,可以在同一行定义多个变量和结构体。
  • 缩进getter,setter的定义和属性观察器的定义。
  • 不需要添加internal这样的默认的修饰符。同样的,不需要在重写一个方法时添加访问修饰符。

Self的使用(Use of Self)

为了保持简洁,避免使用 self 关键词,Swift 不需要使用self来访问对象属性和调用对象方法。

必须使用self来区分构造器中属性命名和参数命名,还有在闭包表达式中引用属性值(编译器需要区分):

1
2
3
4
5
6
7
8
9
10
11
12
class BoardLocation {
let row: Int,column: Int

init(row: Int,column: Int) {
self.row = row
self.column = column

let closure = {
println(self.row)
}
}
}

协议遵守(Protocol Conformance)

当我们对一个类添加协议时,推荐使用一个单独的类扩展来实现协议的方法。这可以保持协议相关的方法聚合在一起,同时也可以简单的标识出一个协议对应类中需要实现哪些对应的方法。

同时,别忘了添加// MARK:,注释可以使得代码组织的更好!

推荐做法:

1
2
3
4
5
6
7
8
9
10
11
12
13
class MyViewcontroller: UIViewController {
// class stuff here
}

// MARK: - UITableViewDataSource
extension MyViewcontroller: UITableViewDataSource {
// table view data source methods
}

// MARK: - uiscrollviewdelegate
extension MyViewcontroller: uiscrollviewdelegate {
// scroll view delegate methods
}

不推荐做法:

1
2
3
class MyViewcontroller: UIViewController,UITableViewDataSource,uiscrollviewdelegate {
// all methods
}

计算属性(Computed Properties)

为了保持简洁,如果一个计算属性是只读的,请忽略掉get语句。只有在需要定义set语句的时候,才提供get语句。

推荐做法:

1
2
3
var diameter: Double {
return radius * 2
}

不推荐做法:

1
2
3
4
5
var diameter: Double {
get {
return radius * 2
}
}

函数声明(Function Declarations)

保证短的函数定义在同一行中,并且包含左大括号:

1
2
3
func reticulateSplines(spline: [Double]) -> Bool {
// reticulate code goes here
}

在一个长的函数定义时,在适当的地方进行换行,同时在下一行中添加一个额外的缩进:

1
2
3
4
func reticulateSplines(spline: [Double],adjustmentFactor: Double,
translateConstant: Int,comment: String)
-> Bool {

// reticulate code goes here
}

闭包表达式(Closure Expressions)

如果闭包表达式参数在参数列表中的最后一个时,使用尾部闭包表达式。给定闭包参数一个描述性的命名。

推荐做法:

1
2
3
4
5
6
7
8
9
10
11
12
UIView.animateWithDuration(1.0) {
self.myView.alpha = 0
}

UIView.animateWithDuration(1.0,
animations: {
self.myView.alpha = 0
},
completion: { finished in
self.myView.removeFromSuperview()
}
)

不推荐做法:

1
2
3
4
5
6
7
8
9
10
UIView.animateWithDuration(1.0,animations: {
self.myView.alpha = 0
})

UIView.animateWithDuration(1.0,
animations: {
self.myView.alpha = 0
}) { f in
self.myView.removeFromSuperview()
}

当单个闭包表达式上下文清晰时,使用隐式的返回值:

1
2
3
attendeeList.sort { a,b in
a > b
}

类型(Types)

尽可能使用 Swift 原生类型。Swift 提供到 Objective-C 类型的桥接,所以你仍然可以使用许多需要的方法。

推荐做法:

1
2
let width = 120.0                                    // Double
let widthString = (width as NSNumber).stringValue // String

不推荐做法:

1
2
let width: NSNumber = 120.0                          // NSNumber
let widthString: Nsstring = width.stringValue // Nsstring

在 Sprite Kit 代码中,使用 CGFloat 可以使得代码更加简明,避免很多转换。

常量(Constants)

常量定义使用let关键字,变量定义使用var关键字,如果变量的值不需要改变,请尽量使用let关键字。

提示:一个好的技巧是,使用let定义任何东西,只有在编译器告诉我们值需要改变的时候才改成var定义。

可选类型(Optionals)

当nil值是可以接受的时候时,定义变量和函数返回值为可选类型(?)。

当你确认变量在使用前已经被初始化时,使用!来显式的拆包类型,比如在viewDidLoad中会初始化subviews

当你访问一个可选值时,如果只需要访问一次或者在可选值链中有多个可选值时,请使用可选值链:

1
self.textContainer?.textLabel?.setNeedsdisplay()

当需要很方便的一次性拆包或者添加附加的操作时,请使用可选值绑定:

1
2
3
if let textContainer = self.textContainer {
// do many things with textContainer
}

当我们命名一个可选变量和属性时,避免使用诸如optionalStringmaybeView这样的命名,因为可选值的表达已经在类型定义中了。

在可选值绑定中,直接映射原始的命名比使用诸如unwrappedViewactualLabel要好。

推荐做法:

1
2
3
4
5
6
7
var subview: UIView?
var volume: Double?

// later on...
if let subview = subview,volume = volume {
// do something with unwrapped subview and volume
}

不推荐做法:

1
2
3
4
5
6
7
8
var optionalSubview: UIView?
var volume: Double?

if let unwrappedSubview = optionalSubview {
if let realVolume = volume {
// do something with unwrappedSubview and realVolume
}
}

结构体构造器(Struct Initializers)

使用原生的 Swift 结构体构造器,比老式的几何类(CGGeometry)的构造器要好。

推荐做法:

1
2
let bounds = CGRect(x: 40,y: 20,width: 120,height: 80)
let centerPoint = CGPoint(x: 96,y: 42)

不推荐做法:

1
2
let bounds = CGRectMake(40,20,120,80)
let centerPoint = CGPointMake(96,42)

推荐使用结构体限定的常量CGRect.infiniteRect,CGRect.nullRect等,来替代全局常量CGRectInfinite,CGRectNull等。对于已经存在的变量,可以直接简写成.zeroRect

类型推断(Type Inference)

推荐使用更加紧凑的代码,让编译器能够推断出常量和变量的类型。除非你需要定义一个特定的类型(比如CGFloatInt16),而不是默认的类型。

推荐做法:

1
2
3
4
let message = "Click the button"
let currentBounds = computeViewBounds()
var names = [String]()
let maximumWidth: CGFloat = 106.5

不推荐做法:

1
2
3
let message: String = "Click the button"
let currentBounds: CGRect = computeViewBounds()
var names: [String] = []

注意:遵守这条规则意味选择描述性命名比之前变得更加重要。

语法糖(Syntactic Sugar)

推荐使用类型定义简洁的版本,而不是全称通用语法。

推荐做法:

1
2
3
var deviceModels: [String]
var employees: [Int: String]
var faxnumber: Int?

不推荐做法:

1
2
3
var deviceModels: Array<String>
var employees: Dictionary<Int,String>
var faxnumber: Optional<Int>

控制流(Control Flow)

推荐循环使用for-in表达式,而不使用for-condition-increment表达式。

推荐做法:

1
2
3
4
5
6
7
for _ in 0..<3 {
println("Hello three times")
}

for (index,person) in enumerate(attendeeList) {
println("\(person) is at position #\(index)")
}

不推荐做法:

1
2
3
4
5
6
7
8
for var i = 0; i < 3; i++ {
println("Hello three times")
}

for var i = 0; i < attendeeList.count; i++ {
let person = attendeeList[i]
println("\(person) is at position #\(i)")
}

Swift 风格指南的更多相关文章

  1. HTML5 WebSocket实现点对点聊天的示例代码

    这篇文章主要介绍了HTML5 WebSocket实现点对点聊天的示例代码的相关资料,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

  2. ios – 在Swift的UIView中找到UILabel

    我正在尝试在我的UIViewControllers的超级视图中找到我的UILabels.这是我的代码:这是在Objective-C中推荐的方式,但是在Swift中我只得到UIViews和CALayer.我肯定在提供给这个方法的视图中有UILabel.我错过了什么?我的UIViewController中的调用:解决方法使用函数式编程概念可以更轻松地实现这一目标.

  3. ios – 在Swift中将输入字段字符串转换为Int

    所以我非常擅长制作APP广告Swift,我试图在文本字段中做一些非常简单的输入,取值,然后将它们用作Int进行某些计算.但是’vardistance’有些东西不正确它是导致错误的最后一行代码.它说致命错误:无法解开Optional.None解决方法在你的例子中,距离是一个Int?否则称为可选的Int..toInt()返回Int?因为从String到Int的转换可能失败.请参阅以下示例:

  4. 如何在iOS中检测文本(字符串)语言?

    例如,给定以下字符串:我想检测每个声明的字符串中使用的语言.让我们假设已实现函数的签名是:如果没有检测到语言,则返回可选字符串.因此,适当的结果将是:有一个简单的方法来实现它吗?

  5. xamarin – 崩溃在AccountStore.Create().保存(e.Account,“);

    在Xamarin.Forms示例TodoAwsAuth中https://developer.xamarin.com/guides/xamarin-forms/web-services/authentication/oauth/成功登录后,在aOnAuthenticationCompleted事件中,应用程序在尝试保存到Xamarin.Auth时崩溃错误说不能对钥匙串说期待着寻求帮助.解决方法看看你

  6. ios – 将视频分享到Facebook

    我正在编写一个简单的测试应用程序,用于将视频从iOS上传到Facebook.由于FacebookSDK的所有文档都在Objective-C中,因此我发现很难在线找到有关如何使用Swift执行此操作的示例/教程.到目前为止我有这个在我的UI上放置一个共享按钮,但它看起来已禁用,从我读到的这是因为没有内容设置,但我看不出这是怎么可能的.我的getVideoURL()函数返回一个NSURL,它肯定包含视

  7. xcode – 错误“线程1:断点2.1”

    我正在研究RESTAPI管理器.这是一个错误,我无法解决它.我得到的错误在下面突出显示.当我打电话给这个班级获取资源时:我评论的线打印:Thread1:breakpoint2.1我需要修复错误的建议.任何建议都非常感谢解决方法您可能在不注意的情况下意外设置了断点.单击并拖动代表断路器外部断点的蓝色刻度线以将其擦除.

  8. ios – 更改导航栏标题swift中的字符间距

    类型的值有人可以帮我这个或建议一种不同的方式来改变swift中导航栏标题中的字符间距吗?解决方法您无法直接设置属性字符串.你可以通过替换titleView来做一个技巧

  9. ios – 如何从变量访问属性或方法?

    是否可以使用变量作为Swift中方法或属性的名称来访问方法或属性?在PHP中,您可以使用$object->{$variable}.例如编辑:这是我正在使用的实际代码:解决方法你可以做到,但不能使用“纯粹的”Swift.Swift的重点是防止这种危险的动态属性访问.你必须使用Cocoa的Key-ValueCoding功能:非常方便,它完全穿过你要穿过的字符串到属性名称的桥,但要注意:这里是龙.

  10. ios – 如果我将自动释放的对象桥接到Core Foundation,我必须使用__bridge或__bridge_retained吗?

    ARC迁移工具遇到了这个问题:特别是,它不确定它是否应该执行__bridge或__bridge_retained.而我也是.-fileURLWithPath返回一个自动释放的对象,在这个地方我不是fileURL的所有者.但与此同时,该对象的保留计数至少为1.我敢打赌,这只能用__bridge来完成.解决方法您只想为此使用常规__bridge强制转换.仅当您想要管理强制转换CF对象的生命周期时,才会使用__bridge_retained.例如:所以__bridge_retained确实告诉编译器你有一个AR

随机推荐

  1. Swift UITextField,UITextView,UISegmentedControl,UISwitch

    下面我们通过一个demo来简单的实现下这些控件的功能.首先,我们拖将这几个控件拖到storyboard,并关联上相应的属性和动作.如图:关联上属性和动作后,看看实现的代码:

  2. swift UISlider,UIStepper

    我们用两个label来显示slider和stepper的值.再用张图片来显示改变stepper值的效果.首先,这三个控件需要全局变量声明如下然后,我们对所有的控件做个简单的布局:最后,当slider的值改变时,我们用一个label来显示值的变化,同样,用另一个label来显示stepper值的变化,并改变图片的大小:实现效果如下:

  3. preferredFontForTextStyle字体设置之更改

    即:

  4. Swift没有异常处理,遇到功能性错误怎么办?

    本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请发送邮件至dio@foxmail.com举报,一经查实,本站将立刻删除。

  5. 字典实战和UIKit初探

    ios中数组和字典的应用Applicationschedule类别子项类别名称优先级数据包contactsentertainment接触UIKit学习用Swift调用CocoaTouchimportUIKitletcolors=[]varbackView=UIView(frame:CGRectMake(0.0,0.0,320.0,CGFloat(colors.count*50)))backView

  6. swift语言IOS8开发战记21 Core Data2

    上一话中我们简单地介绍了一些coredata的基本知识,这一话我们通过编程来实现coredata的使用。还记得我们在coredata中定义的那个Model么,上面这段代码会加载这个Model。定义完方法之后,我们对coredata的准备都已经完成了。最后强调一点,coredata并不是数据库,它只是一个框架,协助我们进行数据库操作,它并不关心我们把数据存到哪里。

  7. swift语言IOS8开发战记22 Core Data3

    上一话我们定义了与coredata有关的变量和方法,做足了准备工作,这一话我们来试试能不能成功。首先打开上一话中生成的Info类,在其中引用头文件的地方添加一个@objc,不然后面会报错,我也不知道为什么。

  8. swift实战小程序1天气预报

    在有一定swift基础的情况下,让我们来做一些小程序练练手,今天来试试做一个简单地天气预报。然后在btnpressed方法中依旧增加loadWeather方法.在loadWeather方法中加上信息的显示语句:运行一下看看效果,如图:虽然显示出来了,但是我们的text是可编辑状态的,在storyboard中勾选Editable,再次运行:大功告成,而且现在每次单击按钮,就会重新请求天气情况,大家也来试试吧。

  9. 【iOS学习01】swift ? and !  的学习

    如果不初始化就会报错。

  10. swift语言IOS8开发战记23 Core Data4

    接着我们需要把我们的Rest类变成一个被coredata管理的类,点开Rest类,作如下修改:关键字@NSManaged的作用是与实体中对应的属性通信,BinaryData对应的类型是NSData,CoreData没有布尔属性,只能用0和1来区分。进行如下操作,输入类名:建立好之后因为我们之前写的代码有些地方并不适用于coredata,所以编译器会报错,现在来一一解决。

返回
顶部