如何在Headerdoc中标记代码段？

Question

我通常需要在代码注释中编写许多短代码this.这可以在Apple的Headerdoc中使用吗？因为这种类型的代码符号通常被大量使用,所以我相信有一种方便的方法来执行此操作而不是标记HTML标记.

Answer 1

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

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

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

/**
 * @c is enough
 */

Answer 2

我最终使用了@c.

This is an example @c code-style text.