Xcode 没有为 Objective-C 代码正确格式化文档注释答案

【问题标题】：Xcode not formatting document comment properly for Objective-C codeXcode 没有为 Objective-C 代码正确格式化文档注释
【发布时间】：2019-09-18 08:48:49
【问题描述】：

我为代码添加了以下带有反引号的注释：

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

但反引号打印在 Xcode 快速帮助中：

如何让 Xcode 显示格式正确的代码？记录 Swift 源代码时效果很好。

【问题讨论】：

尝试使用 @p 或 @c 这篇文章有点老了，但仍然有很多有用的选项：stackoverflow.com/a/19169271/7833793 或者，如果你想使用 @ 做一个更大的代码块代码 // @endcode
所以你说 Swift 使用 markdown 而 Objective C 没有。对 Apple 来说这是多么奇怪的事情。
果然，/// Checks if the given data is of type @c list. 有效。很奇怪。
@R4N 也许发表您的评论作为答案，包括指出对于 Objective-C 代码，您使用 Objective-C 样式，而对于 Swift，您使用 markdown 样式。
@Kalle 添加了答案，感谢您的跟进。

标签： objective-c xcode code-documentation

【解决方案1】：

正如上面 cmets 中所讨论的，在 Objective-C 文档 cmets 中，您可以使用 @p 或 @c 在 QuickHelp 文档中显示 Typewriter 字体。而 Swift 文档 cmets 接受 Markdown（使用反引号）

虽然这个答案相对较旧，但它仍然列出了 Objective-C 文档 cmets 中可用的大量选项：https://stackoverflow.com/a/19169271/7833793

这是一个简短的例子：

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

在 QuickHelp 中显示：

【讨论】：