当前位置: 代码迷 >> Iphone >> 新手关于ios代码注释有关问题
  详细解决方案

新手关于ios代码注释有关问题

热度:64   发布时间:2016-04-25 05:56:14.0
新手关于ios代码注释问题
本帖最后由 yangfanacc 于 2013-10-21 17:37:58 编辑
刚到公司里面学习ios的开发,什么都不是很懂。也是正在学习中。可是今天看同事的项目代码,发现了一个很让我揪心的问题,就是我看不懂。不是我十分的看不懂代码,而是我不知道他的代码都是代表什么意思。我是做java 的,我写java的时候习惯用注释可是在这里发现没有注释的日子太难过了。我也不知道ios里面的注释有什么规矩没有?请教相关的同行们给一些好的建议。
注释 ios 新手 注释规范

------解决方案--------------------
引用:
Quote: 引用:

Quote: 引用:

显然我不需要这样的答案啊,我需要的是注释的规范,例如对于每个类的.m文件是不是需要注释说明作用,是不是每个方法都需要说明用处以及whatwhatwhat等等,期待答案,


X﹏X。。。。。注释这个东西。。仁者见仁智者见智啊,你想写清楚一点也行,完全不写都可以。。。

不过如果你说规范的话,参考Apple官方的demo的话
1)项目里面有个readMe.txt,这个主要是介绍性的注释,版本更新啊、以及一些重要类的讲解与用法。
2).h与.m前面一般有一大段无用的责任声明还是什么的,有些有一点简单的介绍。不是重点注释,关于方法的介绍都丢在readMe了。
3)"//"的话,用在需要简单注释的地方,用法比较灵活
4)#param mark 用在大段的内容开头,用于分割与上文的方法。就比如
#param mark UITableViewDelegate
.....
#param mark UITableViewDataSource
...

这就说明上面一段是讲UITableViewDelegate 代理里面的方法,然后UITableViewDataSource就是另一个代理咯。

注释这个东西别太纠结- -。。。因为好的代码是不需要太多注释的,一看就懂。

谢谢你,

给分撒。。
  相关解决方案