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

EN

我没有用过'appledoc'，但是从你链接的页面看起来它是一个开源的命令行工具。因此，第一步是编译“appledoc”程序本身，然后将其放在路径中的一个目录中，比如/usr/local/bin或~/bin/。

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

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

如果您想在每次构建某个项目时使用'appledoc‘重新生成文档，您可以在项目中的现有目标中添加一个“运行脚本”构建阶段，或者为除了“运行脚本”构建阶段之外什么都没有的文档创建一个新目标。无论哪种方式，该阶段中的脚本都应该是包含类似于上面的命令的shell脚本(尽管您可能希望显式地指定源目录，而不是只使用“当前”目录，即.)。

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

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

据我所知，尽管git repository.

• There's没有安装模板文件(请参阅this link).

)，但您可以使用git

• 中包含的install-appledoc.sh脚本进行homebrew操作

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

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

appledoc --项目名称BabelCPP --项目公司“我的名称”--公司id com.mycompany --no-create-docset --output./doc/。

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