许多语言都支持文档注释，以允许生成器(如javadoc或doxygen)通过解析相同的代码来生成代码文档。
Swift有类似的文档注释功能吗?
当前回答
是的。基本公共(我用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#>.
*/
其他回答
如果你只使用Swift，那么Jazzy值得一看。
https://github.com/realm/jazzy
从Xcode 5.0开始，支持Doxygen和HeaderDoc结构化注释。
源
Jazzy可以帮助生成漂亮的苹果风格的文档。 下面是一个示例应用程序，详细介绍了如何快速使用和配置。
https://github.com/SumitKr88/SwiftDocumentationUsingJazzy
是的。基本公共(我用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#>.
*/
也许关注一下AppleDoc或苹果自己的HeaderDoc是个好主意，它不太被认可。 我仍然可以在10.9 Mavericks终端中找到一些HeaderDoc提示(headerdoc2html)
我推荐阅读最新的“Xcode的新功能”*(不确定它是否仍处于保密协议之下) *链接指向Xcode 5.1版本，其中也包含有关HeaderDoc的信息。
