Xcode not formatting document comment properly for Objective-C code

Question

I added the following comment with backtick for code:

/** Checks if the given data is of type `list`. */
+ (BOOL)isList:(id)object {
    // ..
}

but the backtick prints as in the Xcode quick help:

How to get Xcode to display code formatted properly? It works fine when documenting Swift source.

try using @p or @c this post is a bit old, but still has a bunch of useful options: stackoverflow.com/a/19169271/7833793 alternatively if you're trying to do a larger code block using @code // @endcode — R4N
– R4N, Commented Apr 29, 2019 at 17:50
So you’re saying Swift uses markdown but Objective C doesn’t. What an odd thing for Apple to do. — matt
– matt, Commented Apr 29, 2019 at 17:58
Sure enough, /// Checks if the given data is of type @c list. works. Weird. — matt
– matt, Commented Apr 29, 2019 at 18:02
@R4N Maybe post your comment as an answer, including pointing out that for Objective-C code, you use the Objective-C style, and for Swift you use the markdown style. — Kalle
– Kalle, Commented Oct 25, 2021 at 7:03

R4N · Accepted Answer · 2021-10-25 19:33:22Z

3

As discussed in the comments above, in Objective-C documentation comments you can use @p or @c to display Typewriter font in the QuickHelp documentation. Whereas Swift documentation comments accept Markdown (using the backticks)

While this answers is relatively old, it still lists a good amount of the options available in Objective-C documentation comments: https://stackoverflow.com/a/19169271/7833793

Here's a brief example:

/// Here's how to use @c Typewriter @c Font
- (void)myMethod {}

Which displays this in the QuickHelp:

answered Oct 25, 2021 at 19:33

R4N

2,6251 gold badge9 silver badges12 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Xcode not formatting document comment properly for Objective-C code

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related