iOS 文档 - HeaderDoc

本文主要讲解一下,使用Xcode自带的HeaderDoc工具来自动生开发文档。

背景:公司要研发人员,必须给出开发文档。

这难不倒我们,哈哈哈!!

常用的自动生成文档,有三个:HeaderDoc、AppleDoc、和。。

我刚开始使用了AppleDoc,搞不定啊,我擦。

最终方案,使用HeaderDoc。

官方介绍:https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html#//apple_ref/doc/uid/TP40001215-CH345-SW1


使用方法,一般是将文件输出:

第一步:headerdoc2html -o ./Doc *.h

解释:-o 的意思是-output file;./Doc就是output的文件路径(在此是当前文件夹下,我自己建了一个Doc folder;*.h是指处理所有的.h文件)

第二步:gatherheaderdoc ./Doc index.html

xcode自带了headerDoc,它的路径是:~/Applications/Xcode-beta.app/Contents/Developer/usr/share/headerdoc

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 1、通过CocoaPods安装项目名称项目信息 AFNetworking网络请求组件 FMDB本地数据库组件 SD...
    阳明AI阅读 16,038评论 3 119
  • 小宝今天早上问我,妈妈星期天你有空陪我去上学吗? 我问:星期天也要上学吗? 小宝说星期天我们要去画风筝,然后放风筝...
    镜子中的自己阅读 1,176评论 1 2
  • 我梦见一个女孩 她敲开我沉睡的窗 把影子 盖在我身上 微启的双唇 喝光我所有的幻想 给她 全都给她罢 原来春天还有...
    荞芽儿阅读 1,482评论 0 1
  • 助推教练,勇敢的第一次尝试 by拾忆芳华 课程结束是助推工作新的开始 by勇哥在进化 #F43大宝#DISC学习之...
    拾忆芳华阅读 3,474评论 2 11
  • 84 无论你之前做过什么,多么强大。在你想做另一件事时,你的心态就要清零,回归学习的状态。 这片土地就是换了一个产...
    馨之芬芳阅读 1,189评论 1 2