锁定老帖子 主题:你写注释吗?
精华帖 (0) :: 良好帖 (2) :: 新手帖 (1) :: 隐藏帖 (24)
|
|
---|---|
作者 | 正文 |
发表时间:2009-05-24
visualcatsharp 写道 ozzzzzz 写道 javadoc这样的东西不是注释,而更加类似一种编程语言?
请说出javadoc不是注释,或者不具体注释的功能理由,如果说不出请收回自己的说话。 还有,如果谁能使用jdk里任何api都不看注释的,我只说尊之为神了。 奉劝一句,说话不要这么绝对! 哈哈,确实有趣。 请问你如何看jdk里面的注视。你给我们演示一下行不。 至于我说javadoc不是注释,理由很简单。这个东西有明确的格式要求,和内容要求,是受到严格约束的。并且我见到的一般情况,这个东西又是对客户开放的。一般情况下,这个东西都会受到严格的审查和多人的评议。质量一般还是可以得到保证的。而你说的注释有个功能吗? 我特别奇怪的是,你们究竟如何看jdk里面的注释的。 |
|
返回顶楼 | |
发表时间:2009-05-24
我是不是要把《clean code》里关于comment那一章全部贴出来?
现在的小孩还真是什么都敢说~ |
|
返回顶楼 | |
发表时间:2009-05-27
ozzzzzz 写道 visualcatsharp 写道 ozzzzzz 写道 javadoc这样的东西不是注释,而更加类似一种编程语言?
请说出javadoc不是注释,或者不具体注释的功能理由,如果说不出请收回自己的说话。 还有,如果谁能使用jdk里任何api都不看注释的,我只说尊之为神了。 奉劝一句,说话不要这么绝对! 哈哈,确实有趣。 请问你如何看jdk里面的注视。你给我们演示一下行不。 至于我说javadoc不是注释,理由很简单。这个东西有明确的格式要求,和内容要求,是受到严格约束的。并且我见到的一般情况,这个东西又是对客户开放的。一般情况下,这个东西都会受到严格的审查和多人的评议。质量一般还是可以得到保证的。而你说的注释有个功能吗? 我特别奇怪的是,你们究竟如何看jdk里面的注释的。 一轮自行车由于装了马达,难道就不是自行车了?真是强词夺理。 如果我在公司内部弄了个框架,假设这框架的完美程度已经达到了不需要再作太多的改进的程度下,那么我在这个框架里写的注释的作用跟javadoc的作用类不类似?它严格不严格?至少我答案是肯定的,只是严格的范围和所谓的审查的范围变窄了,只适用于公司内部。难道就因为基本不再变动这个原因失去了它作为注释的理由吗? 至于如何看jdk的注释,我只能老老实实的答你,jdk里的api我还没完全搞懂,例如IO包里有一些类我根本没记得,甚至没看过,但我只能猜想存在着这个类,因为IO这东西其实是操作系统决定的,因此c++/.net/java里都有着类似的体系,很多时候在.net里用过某个类,那么便猜想java里也应该有。这时候难道看注释就错了? |
|
返回顶楼 | |
发表时间:2009-05-27
黑暗浪子 写道 我是不是要把《clean code》里关于comment那一章全部贴出来?
现在的小孩还真是什么都敢说~ 有理由就说出来,不要在这里装b。 不是人人都看过《clean code》,人家也随便能找本书出来是你没看过的。 |
|
返回顶楼 | |
发表时间:2009-06-04
注释还是很重要的,假设你需要去维护别人的代码或者该bug,如果有注释可以很快知道这段代码是做什么的,是不是我需要关心的,如果不是可以马上跳过,看下一部分,如果没有注释,你可能看半个小时也不知道你要找的东西在哪里。
如果你想研究代码的详细内容,注释也是个很好的切入点,可以帮助你的理解,哪怕注释和实际实现不太一样,你好歹比较容易知道哪里不同,当前的实现是不是有问题。 在我们之前项目里,我是鼓励开发人员写注释的,这样会大量减少之后的维护工作量,而且应该得到不错的效果,而且说白了,写好注释要比写好代码容易多了。 |
|
返回顶楼 | |