如何在 Headerdoc 中标记代码片段？答案

【问题标题】：How to mark code snippet in Headerdoc?如何在 Headerdoc 中标记代码片段？
【发布时间】：2011-12-24 01:53:48
【问题描述】：

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

【问题讨论】：

【解决方案1】：

你需要格式化一段代码使用：@code &@endcode 标签如：

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

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

/**
 * @c is enough
 */

【讨论】：

【解决方案2】：

在您的 HeaderDoc 中，您可以使用这种格式：

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

【讨论】：

【解决方案3】：

我最终使用了@c。

This is an example @c code-style text.

【讨论】：

【解决方案4】：

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

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

【讨论】：

【解决方案5】：

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

我最终能够使用<tt>code</tt>（电传文本）生成内联代码sn-ps。

【讨论】：