【发布时间】：2011-12-26 14:59:09
【问题描述】：
我查看了 Headerdoc 和 Doxygen 来记录源代码，但它们似乎都需要开发人员首先完成大部分工作。在 Visual Studio 中，键入 \\\ 会生成文档框架，包括方法预期的参数。还有Ghostdoc 根据其名称和参数猜测该方法的作用。 Xcode 有没有类似的东西？
【问题讨论】：
标签： xcode documentation-generation code-documentation
【发布时间】：2011-12-26 14:59:09
【问题描述】：
还有Appledoc，它从源代码、文档集、html 中的 cmets 创建各种文档，看起来就像 Apple 文档。
【讨论】：
-
但这似乎不会生成文档框架。我不是要生成 HTML 文档，只是要生成源代码文档。
-
我不这么认为。如果你不写它，我不知道有什么可以从未注释的源中提取它。
您可以使用VVDocumenter 插件，这是一个非常方便的 XCode 文档插件。
之后，您可以找到您要记录的方法（或任何代码），然后输入///，将为您生成文档，所有参数和返回将被提取为 Javadoc 样式，即与 Appledoc、Doxygen 和 HeaderDoc 兼容。您只需填写内联占位符标记即可完成您的文档。
【讨论】：
下载 XCode 包管理器：Alcatraz，可以使用以下命令轻松完成：
curl -fsSL https://raw.github.com/supermarin/Alcatraz/master/Scripts/install.sh | sh
重新启动 XCode，您将在窗口工具栏菜单中找到一个标有“包管理器”的新选项。然后你可以从那里安装VVDocumenter。
安装 VVDocumenter 后，您需要再次重新启动 XCode，但在重新加载 Xcode 后，您可以键入 /// 以获取编写 cmets 的帮助，这些 cmets 稍后将用于编写您的文档。
【讨论】：