Swift 文档注释@code 等效。

Question

我知道 Swift 文档注释及其许多用于记录代码的标签，如 :param:、:return: 等

但我无法找到或找出与 Swift 等效的 @code Objective-C 文档注释。我想在我的开源项目中的一些 class 的描述中包含一些代码示例，但我不确定该怎么做。

任何人都可以阐明如何做到这一点，或者在这个阶段甚至可以做到这一点吗？

Answer 1

使用appledoc，您只需将代码缩进4个空格

/*!
Documentation for the class.

Here is a code sample

    func code()
    {
        //code
    }
*/

你会注意到 lot of the 格式化 选项类似于 Stack Overflow！他们都使用 Markdown 进行格式化。

我刚好第一次使用 appledoc 记录了一个项目，所以我有一些最近历史上的页面。 code 功能记录在案 here

关于 :code: @code 语法选项的问题。 Appledoc 指令接受任何后跟关键字的非空白字符。对于 Xcode，文档是 只是一个评论。

Directives prefix: Although all directives in examples above use "@" sign as a prefix, you can actually use any non-whitespace char instead, for example \param, $param, %param and so on...

^{^[Source]}

然而，appledoc 似乎并不像 doxygen.

等其他文档工具那样支持常见的 @code

Answer 2

根据 here 的参考，您可以编写代码块的文档，如下所示。

/**
    The area of the `Shape` instance.

    Computation depends on the shape of the instance. For a triangle, `area` will be equivalent to:

      let height = triangle.calculateHeight()
      let area = triangle.base * height / 2
*/
var area: CGFloat { get }

Swift 文档注释@code 等效。

Swift documentation comment @code equivalent.

documentation-generation

ios

swift