如何在目标C中执行文档？

Question

有没有人可以分享在目标C中执行文档的方法？有没有像java一样的标准方法？

Answer 1

所有人的好消息！ ：D最后等了很久之后，Apple为我们的项目引入了解析器注释。根据XCode 5中的new features：

  

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

和Clang 3.2发行说明：

  

Clang解析注释并可以检测语法和语义错误   在评论中。默认情况下，这些警告是关闭的。传递-Wdocumentation   标志以启用有关文档注释的警告。

如果您想查看此新功能的示例，我建议您查看以下文章：Documentation in Xcode 5

Answer 2

我不知道你正在使用什么IDE但是doxygen允许你从Objective-C中的注释（以及C，C ++，Java和其他一些）中生成文档。

如果您正在使用Xcode（只是假设，因为您使用的是Objective-C），似乎确实存在一定程度的集成（未经我测试，只能在Google上找到）：http://developer.apple.com/tools/creatingdocsetswithdoxygen.html < / p>

Answer 3

正如@DiegoPalomar所建议的那样，标准方式是使用Apple的自己的工具 HeaderDoc 在源代码中嵌入结构化注释。

它附带Xcode，因此无需安装。它附带一个命令行脚本，用于生成文档的HTML输出。

HeaderDoc的文档：

• Introduction
• HeaderDoc command-line tool
• HeaderDoc markup

以下是一个例子：

/*!
 *  Takes in a number and adds 4 to it.
 *
 *  @param myNumber a number of type NSInteger.
 *
 *  @return The number with 4 added to it.
 */
- (NSInteger)addFour:(NSInteger)myNumber {
    return myNumber + 4;
}

大加：当你点击你记录的方法时，你的文档会出现在气球中：

HeaderDoc也是开源的：http://www.opensource.apple.com/source/headerdoc/

Answer 4

我认为你正在寻找Doxygen。