Question

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

Swift是否有这样的类型文档评论功能？

Answer 1

以下是一些用于记录Xcode 6中的swift代码的东西。它对冒号非常错误和敏感，但它总比没有好：

class Foo {

    /// This method does things.
    /// Here are the steps you should follow to use this method
    ///
    /// 1. Prepare your thing
    /// 2. Tell all your friends about the thing.
    /// 3. Call this method to do the thing.
    ///
    /// Here are some bullet points to remember
    ///
    /// * Do it right
    /// * Do it now
    /// * Don't run with scissors (unless it's tuesday)
    ///
    /// :param: name The name of the thing you want to do
    /// :returns: a message telling you we did the thing
    func doThing(name : String) -> String {
        return "Did the \(name) thing";
    }
}

上面的内容在快速帮助中呈现，正如您所期望的那样，使用格式化的数字列表，项目符号，参数和返回值文档。

这些都没有记录 - 提交雷达来帮助他们。

Answer 2

Xcode 8中的新功能，您可以选择这样的方法

func foo(bar: Int) -> String { ... }

然后按 command + option + / 或选择＆＃34;结构＆＃34; - ＆＃34;从Xcode＆＃34;编辑＆＃34;添加文档＆＃34; 菜单，它将为您生成以下注释模板：

/// <#Description#>
///
/// - parameter bar: <#bar description#>
///
/// - returns: <#return value description#>

Answer 3

Swift包含“///”评论处理（尽管可能还不是所有内容）。

写下类似的内容：

/// Hey!
func bof(a: Int) {

}

然后选择 - 点击func名称并发表声音：）

Answer 4

我可以确认ShakenManChild提供了peopr解决方案

请确保您在说明下方有一个空行！

An invalid situation

Proper way

Another way

Another commenting style

Answer 5

是。基本常见（我使用Obj-C等效制作了它的片段）

<强>目标-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#>.
*/