6

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

/**
 Fetches a conversation with user.

 @param user The other user in the conversation.

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

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

  • @warning
  • @note

但是，我仍然没有找到一种方法或这是什么格式，以便我可以添加粗体文本、斜体或链接。

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

4

3 回答 3

3

I found out how to get bold and italics. It uses this doxygen format. It doesn't seem to recognize all commands, but some work:

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

The \b there would make network bold. \a yields italics and \c monospaced text.

于 2013-09-27T20:18:19.070 回答
0

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

同时，您可以使用-Wdocumentation和-Wdocumentation-unknown-command（或者更好的是，start with-Weverything和 reduce）等标志，如果遇到无法识别或格式错误的内容，clang 会通知您。如果您想要完整的可用标签列表，我会检查后备箱。

于 2013-09-27T20:01:40.600 回答
0

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

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

您可以查看Header Doc User guide。

显然，它使用了这些功能的一个子集，其中许多都不起作用。

于 2013-09-27T19:39:01.183 回答