How to mark code snippet in Headerdoc?

Question

I usually need to write many short code in code comment like this. Is this possible to use in Apple's Headerdoc? Because this type of code notation is generally used heavily, so i believe there's a convenient way to do this instead of marking HTML tags.

score 6 · Answer 1 · edited Dec 24 '14 at 14:51

6

You need to format a block of code use: @code &@endcode tags like:

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

If you want to format a single word @c is enough, like:

/**
 * @c is enough
 */

edited Dec 24 '14 at 14:51

eonil

83,476
81
317
516

answered Dec 23 '14 at 22:20

Midhun MP

103,496
31
153
200

score 4 · Answer 2 · edited May 23 '17 at 12:34

4

Within your HeaderDoc, you can use this formatting:

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

Source: https://stackoverflow.com/a/19169271/1736056

edited May 23 '17 at 12:34

Community

1
1

answered May 21 '14 at 18:58

ataranlen

138
1
9

1

It doesn't seem to work: `Unknown field type @code in HeaderDoc comment.` – ctn Jul 23 '15 at 11:05

score 1 · Accepted Answer · answered Dec 24 '14 at 00:04

1

I ended up with using @c.

This is an example @c code-style text.

answered Dec 24 '14 at 00:04

eonil

83,476
81
317
516

score 1 · Answer 4 · answered Jul 23 '15 at 11:21

1

@code and @c don't seem to work as of Headerdoc 8.9. I ended up using:

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

answered Jul 23 '15 at 11:21

ctn

2,887
13
23

For whom seeking for the right answer. This your answer. – mkeremkeskin Aug 01 '17 at 09:27

score 1 · Answer 5 · answered Aug 21 '15 at 04:16

1

I'm on Xcode 6.4/HeaderDoc 8.9 and neither @code nor @c work. <pre>code</pre> works but adds newlines.

I ended up being able to produce inline code snippets by using <tt>code</tt> (teletype text).

answered Aug 21 '15 at 04:16

dvs

12,324
6
38
45

How to mark code snippet in Headerdoc?

5 Answers5