iOS开发中往往会需要导出说明文档,让别人去集成【比如:开放平台的API说明】。这些Xcode都以为做好了,现在我们就说说怎么搞,和一些规范:
【说明】这个过程式半自动的:说明需要手写,导出是自动化脚本
首先:来一自动脚本
mkdir -p $(pwd)/headerDoc
find ./DocStatic -name \*.h -print | xargs headerdoc2html -o headerDoc
gatherheaderdoc headerDoc
exit 0
中DocStatic 是你项目的的名称, headerDoc是你生成文档的文件夹名称
这些都是约定的,因此不多说直接上例子
然后,就是怎么吧这个脚本添加进去了:
1⃣️1 Xcode=》File=》Target选择Other中的Aggregate
2⃣️2 project=》Targets,那一列,找到“箭靶”样式的图标,点击添加 选择 New Run Script Phase
3⃣️3 把脚本天际去,build,就会在你的项目目录下生成以文档文件夹
最后是怎么写文档说明了,这些都是有规范的:
我就直接截图了