许多语言都支持文档注释,以允许生成器(如javadoc或doxygen)通过解析相同的代码来生成代码文档。

Swift有类似的文档注释功能吗?


当前回答

Swift包含了"///"注释处理(尽管可能还不是全部)。

可以这样写:

/// Hey!
func bof(a: Int) {

}

然后选项-点击func名称和voilà:)

其他回答

Swift包含了"///"注释处理(尽管可能还不是全部)。

可以这样写:

/// Hey!
func bof(a: Int) {

}

然后选项-点击func名称和voilà:)

我可以确认ShakenManChild已经为人们提供了解决方案

只要确保在描述下面有一个空行!

在Xcode编辑器->结构->添加文档。

如果你只使用Swift,那么Jazzy值得一看。

https://github.com/realm/jazzy

从Xcode 5.0开始,支持Doxygen和HeaderDoc结构化注释。