One of Xcode 5's new features is the ability to document your own code with a special comment syntax. The format is similar to doxygen, but appears to only support a subset of those features.
Which commands are supported, and which ones aren't?
Do any of their usages differ from doxygen?
这是我在 Xcode 5.0.2 中找到的所有选项的示例
这是使用以下代码生成的：
/** First line text.
Putting \\n doesn't create a new line.\n One way to create a newline is by making sure nothing is on that line. Not even a single space character!
@a Italic text @em with @@a or @@em.
@b Bold text with @@b.
@p Typewritter font @c with @@p or @@c.
Backslashes and must be escaped: C:\\foo.
And so do @@ signs: user@@example.com
Some more text.
@brief brief text
@attention attention text
@author author text
@bug bug text
@copyright copyright text
@date date text
@invariant invariant text
@note note text
@post post text
@pre pre text
@remarks remarks text
@sa sa text
@see see text
@since since text
@todo todo text
@version version text
@warning warning text
@result result text
@return return text
@returns returns text
@code
// code text
while (someCondition) {
NSLog(@"Hello");
doSomething();
}@endcode
Last line text.
@param param param text
@tparam tparam tparam text
*/
- (void)myMethod {}
笔记：
/** block */,或以or/*! block */为前缀。/////!@( headerdoc样式) 或\( doxygen样式) 前缀。（即@b两者\b都做同样的事情。）@property文本之前。）它们可以在同一行之后，使用/*!<, /**<, //!<, ///<。@returns.
这将显示简短的文本（没有格式）；如果不存在简短文本，它将显示所有文本的串联，直到第一个@block；如果不存在（例如，您以@return 开头），那么它将连接所有删除所有@commands 的文本。
（见第一个屏幕截图。）
由于 Xcode 5 中的命令与 Doxygen 兼容，您可以下载并使用 Doxygen 生成文档文件。
对于 Doxygen 的一般介绍以及如何记录 Objective-C 代码，这个页面似乎是一个很好的资源。
部分支持的命令说明：
@brief: 将在描述字段的开头插入文本，并且是在代码完成期间出现的唯一文本。以下不起作用：
\n: 不生成换行符。创建换行符的一种方法是确保该行上没有任何内容。甚至没有一个空格字符！\example不支持以下内容（它们甚至不显示为深绿色）：
Apple 使用的似乎是保留关键字，仅在其文档中有效。尽管它们以深绿色显示，但看起来我们不能像 Apple 那样使用它们。您可以在 AVCaptureOutput.h 等文件中查看 Apple 的使用示例。
以下是其中一些关键字的列表：
充其量，关键字会在描述字段中产生一个新行（例如@discussion）。在最坏的情况下，关键字和它后面的任何文本都不会出现在快速帮助中（例如@class）。
Swift 2.0使用以下语法：
/**
Squares a number.
- parameter parameterName: number The number to square.
- returns: The number squared.
*/
注意@param现在的情况- parameter。
您现在还可以在文档中包含项目符号：
/**
- square(5) = 25
- square(10) = 100
*/
有道理的：
您可能需要在文档的最新更改出现之前构建您的项目。
有时这对我来说还不够。关闭 Xcode 并打开项目备份通常可以解决这些情况。
我在 .h 文件和 .m 文件中也得到了不同的结果。当文档注释在头文件中时，我无法获得新行。
Swift 2.0 的大部分格式都发生了变化（从 Xcode7 ß3 开始，在 ß4 中也是如此）
而不是:param: thing description of thing
（就像在 Swift 1.2 中一样）
就是现在- parameter thing: description of thing
大多数关键字已被替换为- [keyword]: [description]而不是:[keyword]: [description]。目前不起作用的关键字列表包括, abstract, discussion, brief, pre, post, sa, see, availability, class, deprecated, method, property, protocol, related, ref。