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

Question

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

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

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

如何让 Xcode 显示格式正确的代码？在记录 Swift 源代码时它工作正常。

标签： objective-cxcodecode-documentation

Answer 1

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

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

这是一个简短的例子：

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

在 QuickHelp 中显示：