Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to mark code snippet in Headerdoc?

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.

like image 253
eonil Avatar asked Nov 08 '11 00:11

eonil


People also ask

How do I attach a snippet?

Open your message, make sure your cursor is clicked into the message body, and then choose the Insert menu. Click on the Screenshot icon. You'll see options to screenshot any open windows you have. You can also choose Screen Clipping at the bottom.

How do I copy a snippet code?

An inline code snippet can be copied by clicking anywhere on the snippet itself. A single line code snippet can be copied by clicking on the “copy” icon. The browser also provides an ability to manually highlight the text and choose “copy” from the context menu (right click).


1 Answers

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
 */
like image 173
Midhun MP Avatar answered Nov 08 '22 07:11

Midhun MP