Question

我知道Swift文档注释及其许多用于记录代码的标记，例如：param：，：return：etc。

但我无法找到或找出与Swift相当的@code Objective-C文档评论。我想在我的开源项目的某些类的描述中包含一些代码示例，但我不知道该怎么做。

有谁可以请说明如何做到这一点，或者在现阶段甚至是可能的？

Answer 1

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

/*!
Documentation for the class.

Here is a code sample

    func code()
    {
        //code
    }
*/

您会注意到lot 的格式选项类似堆栈溢出！他们都使用Markdown进行格式化。

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

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

指令前缀：尽管上面示例中的所有指令都使用＆＃34; @＆＃34;签名作为前缀，您实际上可以使用任何非空白字符，例如\ param，$ param，％param等...

^{^[Source]}

然而，似乎appledoc不支持常见的@code，就像doxygen等其他文档工具一样。

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等价。

2 个答案: