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

Question

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

Answer 1

您需要格式化代码块，使用:@code &@endcode 标签，例如:

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

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

/**
 * @c is enough
 */