ios – Swift文档评论

概述我有几个关于Swift文档评论的问题. >有没有像一些Apple文档那样做一个相关的声明部分.例如,当我的选项单击tablewView(_：heightForRowAtIndexPath :)方法时,它将链接到生成的文档中的其他3个相关方法. > swift有没有任何警告标签？我在Objective-C中知道它允许您在生成的文档中执行@warning并获得粗体警告.但是,警告：在快速的文档评论中没 我有几个关于Swift文档评论的问题.

>有没有像一些Apple文档那样做一个相关的声明部分.例如,当我的选项单击tablewVIEw(_：heightForRowAtIndexPath :)方法时,它将链接到生成的文档中的其他3个相关方法.
> swift有没有任何警告标签？我在Objective-C中知道它允许您在生成的文档中执行@warning并获得粗体警告.但是,警告：在快速的文档评论中没有任何内容,所以如果有另一种方式,我很好奇.
>是否有任何方式将您的文档编成与Apple文档类似的HTML文件.我在其他IDE中知道其他语言,如Eclipse,您可以为代码生成HTML文档. XCode有这个吗？

解决方法 编辑：Swift丰富的文档 has been greately improved in Xcode 6.3 Beta 2 (6D532l).

现在您可以使用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

总结

以上是内存溢出为你收集整理的ios – Swift文档评论全部内容，希望文章能够帮你解决ios – Swift文档评论所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。