Objective c Xcode中的文档注释是什么？

此问题仅供参考。

---

在Xcode设置窗口的“字体和颜色”选项卡中，有文档注释（和关键字）的设置吗？它们是什么？

请随意增强此答案。

文档注释仅为标记为文档的（Objective-C）注释。除了可以在Xcode中设置其他颜色和字体外，它们的处理方式与普通注释相同。一些文档软件甚至可以使用这些注释从给定的头文件和其他源代码自动创建文档

文档注释关键字是为文档注释中关键字后面的文本赋予语义意义的关键字

您可以使用三个斜杠（而不是普通注释中的两个斜杠）创建内联文档注释，并阻止文档。用两颗星代替一颗星的评论（而不是普通评论中的一颗星）。例如：

// Normal inline comment
/// Documentation comment

/* Normal block
comment */
/** Documentation block
comment */

- (void)sendMessage: (id)sender;
/// @description Sends the receiver.
/// @available Version 1.0 through 2.2

您可以通过在“at”符号后指定关键字（仅一个单词）来创建文档注释关键字。例如：

// Normal inline comment
/// Documentation comment

/* Normal block
comment */
/** Documentation block
comment */

- (void)sendMessage: (id)sender;
/// @description Sends the receiver.
/// @available Version 1.0 through 2.2

是一个工具，用于从源代码（包括文档注释和方法签名）创建文档集，并在需要时在Xcode中安装和重新加载。它是一个命令行程序，并且有关于如何将它合并到Xcode构建过程中的说明

一旦有了文档集，就可以通过首选项>下载>文档将其添加到Xcode中

---

以@符号开头的特殊关键字也称为HeaderDoc标记。可在中找到它们的列表。请注意，其中有些是Objto-C，有些是C++。

< P>有很多工具，比如其他的，它们都识别“特殊”注释（称为文档注释）来自动生成代码的文档。 通常，文档注释以一个特殊的序列开始，例如/**（而不仅仅是/*），并包含一些特殊的关键字，这些关键字通常有一个特殊的开始符号，例如@。不同的注释文档生成器之间有很多相似之处，大多数都接受“@param”作为文档参数“@return”作为文档返回值“@throws”作为文档异常，等等

---

在Xcode语法突出显示的上下文中，文档注释是那些带有Xcode碰巧识别的这些特殊开始序列之一的注释。应该注意的是，Xcode可以正确识别一组特定的注释；例如，Doxygen工具还允许/*！和/！（带感叹号）表示文档注释的开始，但Xcode无法识别它。

对于那些没有观看最新注释的人：对于Xcode 5，此功能将内置。它已经在当前的开发者预览中可用（称为quick help，如宣布的）

---

Xcode 5现在内置了对DOxygen风格注释的支持。因此，您可以这样评论您的方法：

/*!
 * Provides an NSManagedObjectContext singleton appropriate for use on the main 
 * thread. If the context doesn't already exist it is created and bound to the 
 * persistent store coordinator for the application, otherwise the existing 
 * singleton contextis returned.
 * \param someParameter You can even add parameters
 * \returns The a shared NSManagedObjectContext for the application.
 */
+ (NSManagedObjectContext *)sharedContext;

内联帮助将如下所示：

快速帮助将如下所示：

侧边栏帮助将如下所示：

下面是一个方便的代码段，您可以在Xcode代码段库中添加该代码段，以简化方法文档：

/**
 <#description#>
 @param <#parameter#>
 @returns <#retval#>
 @exception <#throws#>
 */

/**
@param
@返回
@例外情况
*/

---

现在，你只需输入“doxy”和poof！你有你的doxygen模板。

为什么要费心编辑我的答案，清楚地标记为社区wiki，它基本上包含了你刚才提供的所有信息？@Randy，没有意识到它是一个社区wiki。我尝试了所有这些技术，但仍然无法让XCode 4.6在选项悬停期间显示我的评论（例如，按住alt键，将鼠标移到方法名称上，光标变为？），然后单击）。它会显示声明的位置，但不会显示其他内容。我是做错了什么，还是XCode不支持文档注释？@AlexChaffee:XCode恐怕没有此功能。我希望它有此功能：-（文档注释仅供其他工具使用，而不是苹果的。从Xcode 5中，您可以使用Doxygen风格的注释在Xcode工具内制作文档。请参阅我的关于it@Wonil现在这确实是一个不错的特性，但我发现语法和工具都很难看。我不打算很快使用它，但对其他人来说可以有趣。实际上，XCode5只需解析任何类似于doxygen或headerdoc的注释。这意味着您也可以使用@param，例如Beautiful，我已经渴望这个功能很久了。“这个问题以前被问过。”那么2011年>2013年呢？：-普兰迪，如果你好奇的话，这里有一个关于这个的讨论。链接的dupe实际上是一个不同的问题。这个问题询问什么是文档注释，以及你可以在其中输入什么命令。这假设你已经知道一个是什么，这并不担心命令。