24.Java注释

阅读更多

今天开始说说Java编程语法部分。

 

这部分内容结束后，就可以在API文档（以及百度）的帮助下，开始真正的Java编程探索了。

 

今天说说Java注释。Java注释本身就是规范格式的问题，几乎没什么可说的。。。。这里给还没有什么编程经历的人说说，代码注释的重要性。

 

如果编写过规模比较大的软件（不是练习、范例之类的）的，并且还需要在经过一段时间之后要再回过头来阅读修改，就会深深体会到注释的重要性了，而不是刚看到注释，对注释嗤之以鼻，不屑一顾，觉得没什么可看的。

 

有这样的体会，除非在学校学习过程中有过类似的项目经验，否则很难有所体会。注释本身很简单，但是要写出漂亮，有范儿的注释，没有一定的编程经历功底是不可能的，也是区分新手和老手的方法之一。

 

我是怎么体会到的？切肤之痛啊。当时刚刚实习，水平不行，只好加班赶进度了。在加班到很晚的时候，遇到了一个编程的“小门槛”，当时已经加班工作很长时间了，但是好像是困极了突然灵光乍现，有了个很好的想法（当然，现在看起来还是很笨的方法了），顿时文思如泉涌啊，很快完成了一个复杂的逻辑处理，大功告成，收工回家！但第二天上班后，估计是昨天累过头了，竟然忘了昨晚加班做的代码了，一看方法，觉得没什么用，直接一个delete。当进行测试运行的时候，一看错误提示，才猛然间醒悟啊，各种悔恨啊。那时候没有版本控制系统，只好重新开始写了。没了突然的灵感，写起来那是艰难的过程。

 

因为当时没有写注释。如果有注释的话，第二天即使忘记了，一看注释也知道它的作用，就不会那么轻率的做删除的决定了。

 

虽然很多人提到了，优秀的代码本身就是注释，但是几句言简意赅的说明注释，在让别人阅读代码的时候，还是会带来方便。毕竟在实际工作中，项目时间紧，任务中，一旦遇到问题，别人需要修改你的代码，很难静下心来心平气和的查阅你的代码的（并且很有可能是你的代码早成问题，心情之差可想而知了）。

 

那么在Java代码里面写上注释，是很简单的。但是注释要写什么？

 

就像是会写字了，但是要写出一篇好文章还是很难得。这点同样与写注释和写代码可以相印证。

 

这里不多说，因为一大堆的原则，惯例，对于刚开始学习编程的人来说，是根本无法接受和理解的，这个还需要在以后的练习与开发中去磨练。

 

这里只说一个。一开始，注释不要重复说明代码所做的事情。那样，当别人看你的代码的时候，会觉得你在“侮辱”他的智商。

 

比如：

 

int i = 100;//将100赋值给变量i

 

i = i/2; //将i值除以二2，再赋值给i

 

这样的注释会让人抓狂的。难道我看不出代码这是要干什么么？我要知道的是，你为什么要把100赋值给i，又为什么把i值除以2？这才是代码注释要做的。就是注释最重要的是要说明代码这样做的业务意义，以及这样处理的原因。

 

后面说说Java代码里面如何加入注释。