如何使用 appledoc 生成类似 Apple 的文档答案

【问题标题】：how to use appledoc to generate an Apple-like documentations如何使用 appledoc 生成类似 Apple 的文档
【发布时间】：2012-04-06 03:48:06
【问题描述】：

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

【问题讨论】：

我怀疑大多数人都熟悉 'appledoc' 项目，所以您可能想多解释一下您的问题。

标签： xcode appledoc

【解决方案1】：

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

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

您可以使用 git 存储库中包含的 install-appledoc.sh 脚本。
还有可用的 homebrew 配方，但据我所知，它没有安装模板文件（请参阅 this link）。

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

【讨论】：

【解决方案2】：

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

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

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

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

【讨论】：

【解决方案3】：

正如我在 post 上找到的，您可以使用此命令行生成代码的完整 HTML 文档：

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

最后一个“.”是您的代码的路径。

【讨论】：