Objective c 如何在目标C中编制文档？

有人能分享一下在objective C中编写文档的方法吗？是否有类似java的标准方法？

< p>我想你正在寻找。

我不知道你在使用什么IDE，但让你从Objtovi-C（C++、C++、java等）中的注释生成文档。

---

如果您使用的是Xcode（只是假设，因为您使用的是Objective-C），那么似乎确实存在某种程度的集成（我没有测试，只是在Google上找到）：

这是个好消息在等待了很长时间之后，苹果终于为我们的项目引入了一个解析器注释。根据XCode 5中的说明：

框架API参考文档中的项目文档和 您自己的源代码中的结构化注释将显示在快捷菜单中 “帮助”面板和“代码完成”弹出视图。强氧剂和头孢菌素 结构化注释是受支持的格式

从发行说明中：

Clang解析注释并可以检测语法和语义错误 在评论中。默认情况下，这些警告处于关闭状态。通行证文件 标记以启用有关文档注释的警告

如果你想看到这个新功能的一个例子，我建议你看看下面的文章：

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

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

总部文件：

下面是一个例子：

/*!
 *  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;
}

大加号：alt单击文档化方法时，您的文档将显示在气球中：

---

HeaderDoc也是开源的：

可能与油井重复。。实际上，我正在寻找一些用objective C编写文档的教程。它列出了所有受支持的命令。前3个链接不起作用。