许多语言都支持文档注释,以允许生成器(如javadoc或doxygen)通过解析相同的代码来生成代码文档。
Swift有类似的文档注释功能吗?
许多语言都支持文档注释,以允许生成器(如javadoc或doxygen)通过解析相同的代码来生成代码文档。
Swift有类似的文档注释功能吗?
当前回答
Swift包含了"///"注释处理(尽管可能还不是全部)。
可以这样写:
/// Hey!
func bof(a: Int) {
}
然后选项-点击func名称和voilà:)
其他回答
从Xcode 5.0开始,支持Doxygen和HeaderDoc结构化注释。
源
Swift包含了"///"注释处理(尽管可能还不是全部)。
可以这样写:
/// Hey!
func bof(a: Int) {
}
然后选项-点击func名称和voilà:)
下面是一些在Xcode 6中用于记录swift代码的东西。它有很多bug,对冒号很敏感,但总比没有强:
class Foo {
/// This method does things.
/// Here are the steps you should follow to use this method
///
/// 1. Prepare your thing
/// 2. Tell all your friends about the thing.
/// 3. Call this method to do the thing.
///
/// Here are some bullet points to remember
///
/// * Do it right
/// * Do it now
/// * Don't run with scissors (unless it's tuesday)
///
/// :param: name The name of the thing you want to do
/// :returns: a message telling you we did the thing
func doThing(name : String) -> String {
return "Did the \(name) thing";
}
}
上述内容在快速帮助中呈现,正如您所期望的格式化数字列表、项目符号、参数和返回值文档一样。
所有这些都没有被记录下来-档案雷达来帮助他们前进。
我可以确认ShakenManChild已经为人们提供了解决方案
只要确保在描述下面有一个空行!
在Xcode编辑器->结构->添加文档。