做项目的时候经常找各种各样的资料,有些虽然暂时没用到,但是等到下次需要用到又要到处去搜索了,所以开通个博客,就当做笔记吧,会有很多东西是从其他大神那里找来的,如有侵犯到各位的所有权,该所有权归你们所有。
废话不多说,第一篇,在xcode中如何生成规范的注释呢,这有利于团队的合作开发,自己以后看起代码来也方便的。
第1步 安装 appledoc 安装非常简单,只需要2步:
git clone git://github.com/tomaz/appledoc.git
cd appledoc
sudo sh install-appledoc.sh
第2步,使用appledoc ,只需要调用以下命令即可
1
| appledoc -o ./doc --project-name ynote --project-company youdao . |
appledoc会扫描当前路径下的所有文件,然后生成好文档放到doc目录下。你也可以用appledoc –help查看所有可用的参数。
基本上使用起来还是比较方便的,详细的信息可以查看官方的文档:http://gentlebytes.com/appledoc/
今天找到了另外一种更加方便,更加简单的xcode注释插件
VVDocumente 这个xcode插件很方便的生成注释,生成类似javadoc样式的注释
使用步骤1 https://github.com/onevcat/VVDocumenter-Xcode 下载后运行工程,这样插件就会成功安装在电脑上,关闭xcode,重新打开,然后在你需要注释的方法前面添加 /// 就好了,非常酷,对于做了2年java开发的我来说,太好了。感谢开源。