ios – Swift文档评论

现在您可以使用Markdown来编写Playground和代码文档注释.

>对于丰富的Playground文档,请使用//：或/ *：* /
>对于代码文档,使用///或/ ** * /

示例评论

/// This function returns a *hello* string for a given `subject`.
///
/// **Warning:** The returned string is not localized.
///
/// Usage:
///
///    println(hello("Markdown")) // Hello,Markdown!
///
/// :param: subject The subject to be welcomed.
///
/// :returns: A hello string to the `subject`.
func hello(subject: String) -> String {
    return "Hello,(subject)!"
}

示例popover

广告. 1.否.“相关声明”功能以某种方式从AppleDoc @see标签中覆盖,但不可能在Swift源文件中生成这些标签.

广告.不,我不认为会有一个,因为斯威夫特的安全理念.但是,您可以使用reST强调语法来生成粗体文本：

/// **Warning:** This method does something unsafe.

虽然在文档扩展程序中尚不支持这种格式,但Swift Standard Library文档注释(most notably for String)中这样的语法很常见,表示将在不久的将来添加格式化功能.

广告. Altough Xcode can generate XML representation of the documentation comments,它不能生成一个HTML文件.我知道的唯一工具是这样的,是jazzy.

一旦知道更多的信息或添加了新的功能,这个答案就会被更新.

参考：

> NSHipster: Swift Documentation
> Quick reStructuredText documentation