|
引言: appledoc是一个可以帮你生成Objective-C代码注释的辅助工具,appledoc所生成的注释API文档与苹果类库的API文档保持一致. 这可以让Xcode能够识别出我们自己的API文档.
参考: 1:Mac安装Brew http://blog.csdn.net/chenyi8888/article/details/7345113 2:使用Objective-C的文档生成工具:appledoc http://blog./blog/2012/02/01/use-appledoc-to-generate-xcode-doc/
安装: appledoc的Github托管地址如下: https://github.com/tomaz/appledoc 此版使用Brew安装appledoc 命令:sudo brew install appledoc 如果你事先没有安装Brew,那么上面的命令肯定也就失效了. 安装Brew使用如下命令: 命令:curl -LsSf http://github.com/mxcl/homebrew/tarball/master | sudo tar xvz -C/usr/local --strip 1 注意上面命令中红色标识的路径. 你应该检查一下,你是否有这个路径,如下图所示:
如果没有,就手动创建一个以后,在执行安装Brew的命令.
检测一下Brew是否安装成功. 命令:brew 如果出现一堆brew的使用说明,那么说明已经安装成功了. 接下来回到我们的appledoc 运行以下命令: 命令:sudo brew install appledoc 在执行命令中,还是有可能失败.原因是指定的路径没有足够的读写权限. /usr/local/bin is not writable. You should change its permissions. 那么去红色标识的路径中为其设置读写权限
完成后,此时卸载appledoc. 此时appledoc安装了一半,没有完全安装成功. 命令:brew uninstall appledoc 结束后,再重新执行一次安装.
不出意外的话,应该就安装成功了. 然后同样的检测一下,是否安装成功,调出appledoc的帮助文档. 命令:appledoc --help
使用: 通过以下命令来生成API文档 [csharp] view plaincopy
1:工程名称 2:公司名称 3:工程ID 4:生成结果输出路径 5:扫描哪个路径下的类. 该命令会根据指定的路径将所有的的类遍历一次,当生成成功以后,appledoc会新建一个文本文件来记录生成情况,这个文件存放在上面命令中指定的--output. 执行上面的命令时,请确保删去了所有的换行符以后在执行. 生成的文档会自动存放在Xcode默认的文档目录里: ~/Library/Developer/Shared/Documentation/DocSets 不出意外的话,进入到目录里面就可以看到刚刚执行命令以后生成的文档:
我们都知道按住option键位时,再点击某个方法或者属性名称
总结:
|
|
|
