iOS导出说明文档
2015-07-06 17:15
381 查看
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,就会在你的项目目录下生成以文档文件夹
最后是怎么写文档说明了,这些都是有规范的:
我就直接截图了
相关文章推荐
- iOS酷我音乐导出工具使用说明和原理介绍(提供下载链接及工程源码)
- oracle存储过程--导出数据库表的说明文档
- powerdesinger导出数据库说明文档
- iOS开发申请证书和应用上传步骤详细文档说明
- CaysnPrinter开发包接口说明文档及示例程序 - CAYSN IOS SDK_20160906
- iOS 环信集成问题(连文档都不说明的坑。。)
- iOS 环信集成问题(连文档都不说明的坑。。)
- powerDisigner链接mysql 生成数据库物理视图,并导出word格式的数据库说明文档
- Caysn打印机IOS平台打印示例及接口说明文档 - 20161008
- PowerDesigner中导出设计说明文档
- Caysn打印机IOS平台打印开发包、接口说明文档及示例程序_20170717
- (译) 在IOS中实现导入&导出文档
- iOS 环信集成问题(连文档都不说明的坑。。)
- iOS开发真机测试证书购买说明文档
- 必备文档:iOS常用目录整理说明
- 导出数据库表为world文档说明,以及PowerDesigner导出表结构pdm设计文档
- iOS 注释规范及appledoc文档导出记录
- 自动导出iOS项目技术文档
- 在IOS中实现导入&导出文档