Xcode 5的新文档解析如何工作？

Question

我注意到Xcode 5现在自动解析方法文档。例如：

/**
 Fetches a conversation with user.

 @param user The other user in the conversation.

 @return A conversation
 */
+ (Conversation *)conversationWithUser:(User *)user;

它支持多个@令牌（不知道如何调用它们）。例如：

• @warning
• @note

但是，我仍然没有找到方法或格式，因此我可以添加粗体文字，斜体或链接。

有谁知道这是什么文档格式？

Answer 1

我发现了如何大胆和斜体。它使用this doxygen format。它似乎没有识别所有命令，但有些工作：

/**
 Resumes \b network operation queues.
 */
- (void)resume;

\b会使网络变为粗体。 \a生成斜体和\c等宽文本。

Answer 2

根据XCode 5中的新功能（在文档下）：

  

框架API参考文档中的项目文档和您自己的源代码中的结构化注释显示在快速帮助面板和代码完成弹出视图中。 Doxygen和HeaderDoc结构化注释是受支持的格式。

您可以查看Header Doc User guide。

显然，它使用这些功能的一部分，其中许多功能不起作用。

Answer 3

不完整。它目前不支持所有doxygen标签 - 只是一个基本子集。

与此同时，您可以使用-Wdocumentation和-Wdocumentation-unknown-command等标记（或更好，以-Weverything开头并减少），如果遇到无法识别的内容，则clang会通知您或畸形。如果你想要一个完整的可用标签清单，我会检查后备箱。