Xcode 如何使用appledoc生成类似苹果的文档
我正在阅读关于如何生成类似苹果的HTML文档的文章。我的问题是命令行的用途。我们如何结合命令行和AppleDocXcode项目来生成HTML 我没有使用“appledoc”,但快速查看一下您链接的页面,它似乎是一个开源命令行实用程序。因此,第一步是编译“appledoc”程序本身,然后将其粘贴到路径中的目录中,例如Xcode 如何使用appledoc生成类似苹果的文档,xcode,appledoc,Xcode,Appledoc,我正在阅读关于如何生成类似苹果的HTML文档的文章。我的问题是命令行的用途。我们如何结合命令行和AppleDocXcode项目来生成HTML 我没有使用“appledoc”,但快速查看一下您链接的页面,它似乎是一个开源命令行实用程序。因此,第一步是编译“appledoc”程序本身,然后将其粘贴到路径中的目录中,例如/usr/local/bin或~/bin/ 下一步是尝试使用它生成一些文档(假设您已经创建了它使用的标记文件)。打开终端窗口,导航到文件所在的目录,然后使用链接页面顶部给出的命令: a
/usr/local/bin
或~/bin/
下一步是尝试使用它生成一些文档(假设您已经创建了它使用的标记文件)。打开终端窗口,导航到文件所在的目录,然后使用链接页面顶部给出的命令:
appledoc --project-name appledoc --project-company "Gentle Bytes" --company-id com.gentlebytes --output ~/help .
如果您想在每次生成某个项目时使用“appledoc”重新生成文档,则可以向项目中的现有目标添加“运行脚本”生成阶段,或者仅为只有“运行脚本”生成阶段的文档创建新目标。无论哪种方式,该阶段的脚本都应该是shell脚本,其中包含与上面类似的命令(尽管您可能希望显式指定源目录,而不仅仅是使用“当前”目录,即
) 我是appledoc工具的作者。该工具旨在按照上述Caleb的回答使用。建议的安装方法是从GitHub克隆存储库,在Xcode中打开项目,按照上面的建议构建二进制文件并选择性地将其复制到您的路径。此外,还必须将运行工具所需的模板文件复制到预定义路径之一。所需的所有步骤都在appledoc页面上的自述文件中进行了说明,请参见快速安装部分
还有其他安装方法-所有用户贡献:
- 您可以使用git存储库中包含的
脚本安装appledoc.sh
- 也有可用的配方,尽管据我所知它没有安装模板文件(请参阅)
最后一个“.”是您的代码路径。我怀疑大多数人是否熟悉“appledoc”项目,因此您可能需要进一步解释您的问题。