如何在Headerdoc中标记代码段？

Question

我通常需要在代码注释中编写许多短代码，例如this。这可以在Apple的 Headerdoc 中使用吗？因为这种类型的代码符号通常被大量使用，所以我相信有一种方便的方法来代替标记HTML标记。

Answer 1

您需要格式化一段代码使用：@code＆amp; @endcode标记，如：

/**
 * @code
 * [myObj myMethod];
 * @endcode
 */

如果您想格式化单个单词@c就足够了，例如：

/**
 * @c is enough
 */

Answer 2

在HeaderDoc中，您可以使用以下格式：

 @code
// code text
while (someCondition) {
    NSLog(@"Hello");
    doSomething();
}@endcode
 Last line text.

来源：https://stackoverflow.com/a/19169271/1736056

Answer 3

我最终使用@c。

This is an example @c code-style text.

Answer 4

@code和@c似乎从Headerdoc 8.9开始工作。 我最终使用了：

<pre>@textblock
@/textblock</pre>

Answer 5

我在Xcode 6.4 / HeaderDoc 8.9上，@code和@c都不起作用。 <pre>code</pre>有效，但会添加换行符。

我最终能够使用<tt>code</tt>（电传打字文字）制作内联代码段。