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

Question

我通常需要在代码注释中写很多短代码，比如this。在苹果的Headerdoc中是否可以使用这种代码标记？由于这种类型的代码标记通常被广泛使用，因此我相信有一种方便的方法来代替标记HTML标签。

- eonil

Answer 1

您需要使用@code和@endcode标签对一段代码块进行格式化，例如：

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

如果您想格式化单个单词，只需使用@c即可，例如：

/**
 * @c is enough
 */

- Midhun MP

Answer 2

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

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

来源：https://dev59.com/LGIk5IYBdhLWcg3wi-xM#19169271

下面是需要翻译的内容：

在Python中，如何检查字符串是否为数字？

我正在使用Python 2.7。我正在尝试检查一个字符串是否为数字（整数或浮点数）。我原本以为这很简单：

str.isdigit()

但是，对于负数和小数它却失败了。

我目前正在使用以下方法：

def is_number(s): try: float(s) return True except ValueError: return False 有没有更好的方法呢？

- ataranlen

---

似乎无法正常工作：HeaderDoc注释中存在未知的@code字段类型。 - ctn

Answer 3

我最终使用了 @c。

This is an example @c code-style text.

- eonil

Answer 4

我在使用Xcode 6.4 / HeaderDoc 8.9，但是@code和@c都无法正常工作。<pre>code</pre>可以工作，但会添加换行符。

最终我使用<tt>code</tt>（打字机文本）来生成内联代码片段。

- dvs

Answer 5

@code 和 @c 在 Headerdoc 8.9 中似乎不起作用。 我最终使用了：

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

- ctn

---

寻找正确答案的人，这就是你的答案。 - mkeremkeskin