在之前的Xcode版本中使用注释插件 VVDocumenter 可以快速的根据上下文的环境生成相应的注释格式,但是该插件目前在 Xcode7 bate 版中并不太兼容,这就需要我们了解一下原生的注释格式怎么书写了,现总结以下自己使用的几种格式与大家共同交流。 Swift 中的普通注释与 Objective-C 中的一致,大概分为以下三种 // 单行注释 / * 多行注释 */ /// 标记注释1 /** 标记注释2 */ 针对于 Swift 中函数的原生注释方法在此列举几个如下,使用好了可以让别人更容易读懂我们的代码功能以及具体的参数意义。 示例1: 示例2: 示例3: 示例4: Objective-C 的三种常用注释介绍: 示例1: 示例2: 示例3: 示例4: 最后再补充两个标记注释,可以便利的标记某一块函数列表的功能,已便后续查找维护对应的函数