Xcode文档生成器

Question

我看过Headerdoc和Doxygen来记录源代码，但他们似乎都需要开发人员先完成大部分的工作。在Visual Studio中，键入\\\会生成文档的框架，包括方法所需的参数。还有Ghostdoc根据其名称和参数猜测方法的作用。 Xcode有什么类似的东西吗？

Answer 1

还有Appledoc，它会根据您的来源，docsets，html中的评论创建各种文档，看起来就像Apple文档。

Answer 2

您可以使用VVDocumenter插件，它是XCode文档的一个非常方便的插件。

之后您可以找到要记录的方法（或任何代码），并输入///，将为您生成文档，所有参数和返回将被提取为Javadoc样式，与 Appledoc ， Doxygen 和 HeaderDoc 兼容。您只需填写内联占位符令牌即可完成文档。

Answer 3

下载XCode包管理器：Alcatraz，可以使用以下命令轻松完成：

curl -fsSL https://raw.github.com/supermarin/Alcatraz/master/Scripts/install.sh | sh

重新启动XCode，您将在“工具栏”菜单中找到一个新选项，其中包含“程序包管理器”。然后，您可以从那里安装VVDocumenter。

安装VVD文件管理器后，您需要再次重新启动XCode，但在重新加载Xcode之后，您可以键入///以获取编写注释的帮助，这些注释稍后将用于编写您的文档。