最近有点小忙,好久没有写文章了。今天我们聊一聊Objective-C技术文档。
独立开发可以不管这些,不过做项目的人多了,就需要文档了,方便其他人员查看使用。手工写文档是一件苦差事,经过查找发现了从源码中抽取注释生成文档的专用工具:
[doxygen](http://www.stack.nl/~dimitri/doxygen/index.html):适于生成html文档与pdf文档。 支持的语言多,可以配置的地方也比较多。默认生成的风格与苹果的风格不一致。
[headdoc](http://developer.apple.com/opensource/tools/headerdoc.html) :是 Xcode 自带的文档生成工具。在安装完 Xcode 后,就可以用命令行来生成对应的文档。不过它只生成以/*! */
的格式的注释。不兼容 /** */
格式的注释
[appledoc](http://gentlebytes.com/appledoc/): [Github地址](https://github.com/tomaz/appledoc) ,适于生成html文档和xcode帮助文档(docset)。可以兼容 /** */
格式,也可以兼容 /*! */
格式的注释。
这些都是前人总结的特点我也没有一个个尝试,我直接选取了 appledoc,下面是安装步骤和使用步骤。
安装
两种方式:
1 如果你装了homebrew,打开终端,输入以下命令:
brew install appledoc
第一次用的这种方式,安装虽然成功了但是去找不到生成的html文件,后来找到了文件打开之后里面的内容却不对,所以如果有朋友看到后可以告诉我怎么回事,先谢谢了~
2 打开终端,输入以下命令:
git clone git://github.com/tomaz/appledoc.git
cd appledoc
sudo sh install-appledoc.sh
安装成功会出现
使用
首先创建一个项目appledoc,为了便于演示,写几个注释:
打开终端进入项目目录
使用命令创建
//格式:appledoc --project-name 你的项目名称 --project-company 你的公司名称 ./
appledoc --project-name appledoc --project-company kt ./
之后打开你的工程文件会看到:
这里的路径就是生成文档的路径了,一般是html格式,顺着路径找下去如图:
右键显示包内容
这个html文件就是你需要的了打开如下:
此时在Xcode中也帮你生成了文档:
退出Xcode,重新打开工程选择在 Help—Documentation and API Reference中也可以看到
当然如果你只是想生成一分html文档的话就只要用终端进入工程目录之后执行下列命令:
//加入--no-create-docset
appledoc --no-create-docset --project-name appledoc --project-company kt ./
虽然有提示但是不影响使用(额,其实是不知道怎么解决,哈哈😀)
在工程目录中会发现多了一个
点击打开发现和刚才的那个一样哎😔
这个就是你的技术文档了,方便他人查看使用。
希望对各位有所帮助吧,别忘了喜欢单赞收藏转发~~~