swift - 如何使用 Xcode 6 内联代码文档 Swift 源代码

Question

我一直在使用 Xcode 5 的功能，通过支持的注释语法 (see this SO question) 来记录我的代码。 Xcode 6 支持 Objective-C 源代码，不幸的是不支持 Swift 源代码。

我想在 .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";
    }
}

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

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