// This is a comment.
你可以（且必需）像上面那样来安排你的注释，以便分清每个部分。但是，当谈到代码注释文档，我必定不是指的上面的注释。如果整个教程都专注于此必定毫无意义。注释文档意味着以布局化的要领使用特殊的关键字，也叫标签来写注释，使用特殊的标记来标示注释区域，因此编译器可以完美的理解这个过程。只有一些简单的法则需要遵守。上面操纵的所有功效就是你的注释文档可以在三个差此外处所展示：
在Utilities面板的Quick Help Inspector 里。
当你按下Option键然后点击要领，类或属性名时弹出的辅佐菜单 Help Popup 里。
在代码实现弹出框里。
除此之外，合适的代码注释让你可以使用众多的工具来为你的应用创建完整的HTML文档，例如the HeaderDoc 。它们两个稍后会提到，而且你会看到我适才所说的是怎样实现的。
记住上面所说的，是时候更近一步了。当使用Objective-C写代码时有三种可能的要领来标示一个注释文档区域：
把你的注释包罗在/** – */ 块里。
把你的注释包罗在 /*! – */块里。
以三条斜杠 ///开始的注释行
在这个教程实例中我们将会用第二种要领来写我们的注释文档。我选择它出于两个原因：第一，它是独一一个能被HeaderDoc识另外格局，而且如果注释块不是以它开头，辅佐页也不会被生成。第二，尽管Doxygen更倾向于第一种格局，它也能识别第二种。因此，第二种格局将会在两种要领下都适用。第三种格局凡是在注释一行时用到，例如属性值时，因此、，我们还是对峙用第二种格局。
此刻，当写注释文档时，你可以使用特定的关键值（或标签）。标签被分为两个大类：第一个是 top level 标签，它可以用来指定哪种类型的代码被注释了，例如类，布局体，文件，等等。注意top level标签不是必需使用，但是必定会辅佐导出工具（例如 HeaderDoc）创建出更好的功效。第二个是second level标签，它指定了每个注释文档块的细节。这个类型的标签正是你需要的，因为每一个都界说了此外的注释文档部分。
下面我给出了最重要的second level标签，但是注意了这并不是全部。我们稍后会看到一些 top level标签。我这里列出来的是最常用到的：
@brief: 使用它来写一段你正在文档化的method, property, class, file, struct, 或enum的短描述信息。
@discussion: 用它来写一段详尽的描述。如果需要你可以添加换行。
@param: 通过它你可以描述一个 method 或 function的参数信息。你可以使用多个这种标签。
@return: 用它来制定一个 method 或 function的返回值。
@see: 用它来指明其他相关的 method 或 function。你可以使用多个这种标签。
@sa: 同前一条类似。
@code: 使用这个标签，你可以在文档傍边嵌入代码段。当在Help Inspector傍边检察文档时，代码通过在一个特另外盒子顶用一种差此外字体来展示。始终记住在写的代码结尾处使用@endcode标签。
@remark:在写文档时，用它来强调任何关于代码的特殊之处。
你可以在 这里 （HeaderDoc User Guide）找到包罗所有撑持的标签的列表。
注意@标记是每个标签的前缀。同样，你也可以在文本中使用特殊字符switches，这样就可以转变它的类型和格局。例如，Text 以会让 Text单词成为黑体，同时Text也会让 Text 单词的类型为italic. 有趣的是你也可以把部分文本以代码形式展现（不是代码段），如果写下@cText，当辅佐文档在Xcode上展现时，它会导致展示一个差此外字体格局。
除开上面说的，你也可以替换@标记为反斜杠(\)。那样的话标签就会像这样被展示： \brief, \param, \return,等等。注意@标记常在HeaderDoc里面被使用。在这里我们会在所有处所使用@，因为它在两个系统中都通用。
Objective-C代码文档化
让我们看看以上我提到的内容是怎样使用的。打开ViewController.m文件，在类的私有部分中添加下面的属性：
@interface ViewController () @property (nonatomic, strong) NSString *myName; @end
然后如下面所示添加注释文档：
/*! @brief This property knows my name. */ @property (nonatomic, strong) NSString *myName;
然后到viewDidLoad要领中，开始输入这个属性。你将看到在代码填充弹出框里我们刚刚写下的注释就在那里！
而且不只这样。当在键盘上按住Option 键，点击myName属性就会让辅佐窗口弹出：
