9

我正在阅读如何在此处生成类似 Apple 的 HTML 文档的文章。我的问题是命令行的用途。我们如何结合命令行和 appledoc xcode 项目来生成 HTML。

4

3 回答 3

19

我是appledoc工具的作者。该工具旨在按照上面 Caleb 的回答使用。推荐的安装方法是从 GitHub 克隆存储库，在 Xcode 中打开项目，构建并选择性地将二进制文件复制到您的路径，如上面建议的那样。此外，您还必须将运行该工具所需的模板文件复制到预定义路径之一。所需的所有步骤都在GitHub上的 appledoc 页面上的自述文件中进行了描述，请参阅快速安装部分。

还有其他安装方法 - 所有来自用户的贡献：

  • 您可以使用install-appledoc.shgit 存储库中包含的脚本。
  • 还有可用的自制配方，尽管它没有安装我理解的模板文件（请参阅此链接）。

如有任何其他问题，请转到appledoc Google 组。我是几天前才创建的，所以在写这篇文章的时候还没有内容，但是请随时在那里提问。

于 2012-03-27T11:49:42.673 回答
13

我没有使用“appledoc”，但快速浏览一下您链接的页面，它似乎是一个开源命令行实用程序。因此，第一步是编译“appledoc”程序本身，然后将其粘贴到路径中的目录中，例如/usr/local/binor ~/bin/。

下一步是尝试使用它来生成一些文档（假设您已经创建了它使用的降价文件）。打开终端窗口，导航到文件所在的目录，然后使用链接页面顶部给出的命令：

appledoc --project-name appledoc --project-company "Gentle Bytes" --company-id com.gentlebytes --output ~/help .

如果您想在每次构建某个项目时使用“appledoc”重新生成文档，您可以将“运行脚本”构建阶段添加到项目中的现有目标，或者仅为只有一个“运行脚本”构建阶段。无论哪种方式，该阶段的脚本都应该是包含类似于上述命令的 shell 脚本（尽管您可能希望明确指定源目录，而不是仅使用“当前”目录，即.）。

于 2012-03-21T16:15:47.217 回答
4

正如我在这篇文章中发现的，您可以使用以下命令行生成代码的完整 HTML 文档：

appledoc --project-name BabelCPP --project-company "我的名字" --company-id com.mycompany --no-create-docset --output ./doc/ 。

最后 ”。” 是您的代码的路径。

于 2014-04-24T19:52:20.773 回答