黑马程序员技术交流社区

标题: 关于注释的疑问 [打印本页]

作者: 余明辉 时间: 2012-8-5 20:20
标题: 关于注释的疑问
java已经有自己定义的注释了，例如
@Override 表示当前方法是覆盖父类的方法。
@Deprecated 表示当前元素是不赞成使用的。
@SuppressWarnings 表示关闭一些不当的编译器警告信息。

但是我们还能自定义注释类，有什么用处呢？感觉这些东西都用不上啊

作者: 金鑫 时间: 2012-8-5 20:48
本帖最后由金鑫于 2012-8-5 20:50 编辑

注释的作用就是说明，说明在当前有注释标明的地方代码的作用。说明某个变量的定义，某个类，某个方法的功能等等。

1、注释很多时候不是给自己看的，而是大部分给别人看的。在实际开发中，程序员往往更多的是讲究合作，每个人能负责一个模块的实现。这时候一个很重要解决的就是团队沟通，每个人的习惯不同，代码的编写都会不同。因此一个人的代码自己看懂不是重点，重点的是要别人看得懂。这时候就要强调程序的可读性了，因为某些代码你写的时候自己心里有数，知道自己这段代码的功能与实现，但是别人不知道，如果不写注释，别人往往是一头雾水，尤其是代码量特别大的时候。想想别人给你一段代码，几百行甚至上千行，一句注释都没有，全都是代码，那是一种什么感觉。

2、注释不是给你当时看的，而是给你过个3，5天或者过几个月看的。很多时候你在编写某些程序的时候，思路很清晰，行云流水下来非常流畅。但是当过了几天甚至几个月之后，你再回来看自己的代码，如果没有注释，很可能你的大脑就会当机，无法找到当时编写时候的感觉，对阅读代码会照成很大的困扰。好记性不如烂笔头，因此当你的程序中某些重要的方法，特殊的类中如果能及时的添加合理的注释，对你无论是程序的编写还是阅读，都会有很大的好处。

3、JAVA中文档注释可以通过JDK中提供的javadoc工具生成API文档，API文档的作用就不用多说了吧，重要性大家都非常清楚。

以上是我个人对注释的理解，打字很累的，希望能对你有些作用。{:soso__8961432591078930798_3:}

作者: 余明辉 时间: 2012-8-5 21:38

金鑫发表于 2012-8-5 20:48
注释的作用就是说明，说明在当前有注释标明的地方代码的作用。说明某个变量的定义，某个类，某个方法的功能 ...

谢谢你的回答，我想问的是注释类，也叫注解类吧，是用@interface typeName { }自己定义的类有什么作用，具体用在什么地方

欢迎光临黑马程序员技术交流社区 (http://bbs.itheima.com/)

黑马程序员IT技术论坛 X3.2