2

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

4

3 回答 3

1

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

之后,您可以找到要记录的方法(或任何代码),然后输入///,将为您生成文档,所有参数和返回将被提取为 Javadoc 样式,该样式与AppledocDoxygen页眉文档。您只需填写内联占位符标记即可完成您的文档。

于 2014-12-24T00:47:33.980 回答
1

还有Appledoc,它根据您的源代码、文档集、html 中的注释创建各种文档,看起来就像 Apple 文档。

于 2011-12-26T15:19:11.543 回答
0

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

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

重新启动 XCode,您将在窗口工具栏菜单中找到一个标有“包管理器”的新选项。然后,您可以从那里安装VVDocumenter 。

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

于 2014-08-29T05:14:32.570 回答