Swift中的代码组织

1、代码组织和Framework
2、安全的资源组织方式
3、文档注释
4、编译标记

1、代码组织和Framework
  • 之前有研究过Swift中framework的制作有一个疑问就是Swift中接口和实现是放在一个文件里,如何做到只向调用者暴露必要的接口而不暴露具体的实现细节?
2、安全的资源组织方式
  • 在Cocoa框架中有不少用字符串指定资源的使用方式,比如通过图片的名字来生成UIImage对象,通过segue的标识符来调用一个storyboard中的segue,但是这种方式不太安全。在Swift中是没有宏定义的,取而代之,我们可以灵活的使用rawValue为String的enum类型,然后通过为资源类型添加合适的extension来让编译器帮助我们在资源名称修改时能在代码中作为对应的改变。
3、文档注释
  • Swift中给方法添加注释的格式
/**方法描述
- parameter 参数名称:参数说明
- returns: 返回值说明
*/
通过Alt + 单击的方式可以快捷查看方法的注释
  • 对于像属性这样的简单的声明,我们直接使用///就可以了。
  • 如果你觉得在Xcode中手写- parameter 或者 - returns这样的东西非常浪费时间的话,可以尝试使用一款叫做VVDocumenter的Xcode插件。
4、编译标记
  • //MARK: 这个就叫编译标记
  • 除了//MARK:以外,Xcode还支持另外几种标记,他们分别是//TODO: 和 //FIXME:。和MARK不同的是,另外两种标记在导航栏中不仅会显示后面跟着的名字或者说明,而且他们本身也会被显示出来,用来提示还未完成的工作或者需要修正的地方。

你可能感兴趣的:(Swift中的代码组织)