Swift文档注释

对于Objective-C来说，这方面的自动生成工具有Apple标准的HeaderDoc，一级第三方的appledoc或者Doxygen等。

/**

A dome method

:param:  input An Int number

:returns: The string represents the input number

*/

func method(input:Int) - > String {

    return String(input)

}

在文档注释的块中（在这里是被/**...*/包围的注释），我们需要使用:param:紧接输入参数名的形式来表达队输入参数的说明。如果有多个参数，我们会需要相应地多写数组:param:语句。如果返回值不是Void的话，我们还需要写:returns:来对返回进行说明。

对于像属性这样的简单的声明，我们直接使用///就可以了。

struct Person {

    ///name of the person

    var name:String

}

现在除了Xcode自身的渲染之外，其他传统的文档自动生成工具还不能很好地读取Swift的文档注释。不过相信很快像headerDoc或者appledoc这样的工具就会进行更新并提供支持，这并没有太大的实现难度。另外，有一个叫作jazzy的新项目在这方面已经做出了一些成果。

也可以使用一款叫作VVDocumenter的XCode插件。