ios - 使用 Appledocs 生成文档

Question

对于我的问题的简单性，我深表歉意，但我正在尝试使用 Appledocs ( https://github.com/tomaz/appledoc#quick-install ) 生成文档

我不确定如何设置它。我的做法是:

• 我克隆了 github 存储库，然后在终端中使用安装脚本 (我使用 appledocs --help 确认) 安装 appledocs。

但是，从我在 xcode 中拥有我的项目的意义上讲，现在我如何实际使用它:

• 如何生成文档文件
• 它是在哪里生成的？

Answer 1

我经常做的是在我的项目中添加一个可以生成文档的新目标。您可以转到项目构建阶段并单击“添加目标”。选择 Other 下的 Aggregate 并为其命名(例如 ProjectDocumentation)。

仍在构建阶段选项卡上，转到“添加构建阶段”并单击“添加运行脚本”。您现在可以粘贴以下内容并将其调整为您自己的设置:

/usr/local/bin/appledoc \
--project-name HereProjectName \
--project-company "HereProjectCompany" \
--company-id com.companyName \
--keep-undocumented-objects \
--keep-undocumented-members \
--search-undocumented-doc \
--exit-threshold 2 \
--ignore .m \
--output "AppleDoc" .

我使用 ignore *.m 因为我只在我的头文件中写文档。我的 *.m 文件中的文档仅供我自己使用(因此是私有(private)的)。当您构建此目标时，文档将生成为 XCode 文档集。这可以通过按住 alt 键并单击类名来访问。查看AppleDoc website用于注释语法。

有关命令行选项的解释，请查看 appledoc --help 命令。