如何使用appledoc生成类似苹果的文档

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

2012-03-21 tranvutuan

我怀疑大多数人都熟悉'appledoc'项目，所以你可能想多解释一下你的问题。 – Caleb 2012-03-21 16:17:07

我还没有使用'appledoc'，但是从快速浏览链接的页面看来，它是一个开源的命令行工具。因此，第一步将编译“appledoc”程序本身，然后将其粘贴到路径中的目录中，如/usr/local/bin或。

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

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

如果你想使用“appledoc”再生您的文档中各个当你创建一个项目时，你可以为项目中的现有目标添加一个“运行脚本”构建阶段，或者为仅具有“运行脚本”构建阶段的文档创建一个新目标。不管怎样，该阶段的脚本应该是包含类似于上述命令的shell脚本（尽管您可能想明确指定源目录，而不是仅使用'current'目录，即.）。

来源

2012-03-21 16:15:47 Caleb

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

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

您可以使用包含在git仓库install-appledoc.sh脚本。
也有homebrew配方可用，虽然它不安装模板文件，我的理解（见this link）。

如有任何其他问题，请转至appledoc Google group。我刚刚在几天前创建它，所以在撰写本文时没有内容，但可以随时在那里提问。

来源

2012-03-27 11:49:42 Tom

正如我在这个post发现，你可以生成你的代码中使用此命令行一个完整的HTML文档：

appledoc --project名BabelCPP --project-公司“我的名字” - -company-id com.mycompany --no-create-docset --output ./doc/。

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

来源

2014-04-24 19:52:20

如何使用appledoc生成类似苹果的文档

回答

相关问题