许多语言都支持文档注释,以允许生成器(如javadoc或doxygen)通过解析相同的代码来生成代码文档。
Swift有类似的文档注释功能吗?
许多语言都支持文档注释,以允许生成器(如javadoc或doxygen)通过解析相同的代码来生成代码文档。
Swift有类似的文档注释功能吗?
当前回答
我可以确认ShakenManChild已经为人们提供了解决方案
只要确保在描述下面有一个空行!
其他回答
我在Xcode二进制文件中发现了一些有趣的东西。以.swiftdoc结尾的文件。 它肯定有文档,因为这些文件包含Swift UIKit / Foundation API的文档,不幸的是,它似乎是一种专有的文件格式,用于Xcode中的文档查看器。
在Xcode编辑器->结构->添加文档。
从Xcode 5.0开始,支持Doxygen和HeaderDoc结构化注释。
源
Swift包含了"///"注释处理(尽管可能还不是全部)。
可以这样写:
/// Hey!
func bof(a: Int) {
}
然后选项-点击func名称和voilà:)
在Xcode 8中,你可以这样选择一个方法
func foo(bar: Int) -> String { ... }
然后按command + option + /或在Xcode的“编辑器”菜单中选择“结构”-“添加文档”,它会为你生成如下注释模板:
/// <#Description#>
///
/// - parameter bar: <#bar description#>
///
/// - returns: <#return value description#>