xcode 生成注释

做项目的时候经常找各种各样的资料,有些虽然暂时没用到,但是等到下次需要用到又要到处去搜索了,所以开通个博客,就当做笔记吧,会有很多东西是从其他大神那里找来的,如有侵犯到各位的所有权,该所有权归你们所有。

废话不多说,第一篇,在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开发的我来说,太好了。感谢开源。




  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值