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

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


当前回答

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

其他回答

也许关注一下AppleDoc或苹果自己的HeaderDoc是个好主意,它不太被认可。 我仍然可以在10.9 Mavericks终端中找到一些HeaderDoc提示(headerdoc2html)

我推荐阅读最新的“Xcode的新功能”*(不确定它是否仍处于保密协议之下) *链接指向Xcode 5.1版本,其中也包含有关HeaderDoc的信息。

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

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

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

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

是的。基本公共(我用Obj-C等效为它制作了片段)

objective - c:

/**
 @brief <#Short description - what it is doing#>

 @discussion <#Description#>

 @param  <#paramName#> <#Description#>.

 @return <#dataType#> <#Description#>.
 */

斯威夫特

/**
<#Short inline description - what it is doing#>

<#Description#>

:param:  <#paramName#> <#Description#>.

:returns: <#dataType#> <#Description#>.
*/