code-snippets - 如何在 Headerdoc 中标记代码片段？

Question

我通常需要在代码注释中写很多短代码，比如this. 这可以在 Apple 的Headerdoc中使用吗？因为这种类型的代码符号通常被大量使用，所以我相信有一种方便的方法可以做到这一点，而不是标记 HTML 标记。

Answer 1

您需要格式化代码块 use: @code&@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>（电传文本）生成内联代码片段。