1.4 程序注释

程序需要加注释，这是为了提高程序的可读性（readability）。一个人写的程序，可能过一段时间需要进行某些修改或补充，这类修改或补充在很多时候更有可能由别人来做，怎样才能使程序更容易读懂和理解？加注释是提高程序可读性最常用的方法。

按现代软件工程思想，注释不必解释程序是怎么工作的（很多人愿意这么注释），因为程序本身的逻辑很好地说明了这一点。注释应该回答程序做什么和为什么这么做这类问题。复杂的注释应该放在方法的头部。

Java语言注释有3种：单行注释、块注释和文档注释。

（1）单行注释，用符号“//”实现单行注释，其后的所有字符都被视为注释，主要对某个语句注释，一般放在所注释的语句的上面或后面。

（2）块注释，或多行注释，块注释从/*开始，到*/结束，不能嵌套。

//this is main method

/*

*This is Java block remarks

*for method functionality specification

*/

（3）文档注释（Javadoc comment），文档注释从/**开始，到*/结束，主要用于描述数据、方法和类，使用JDK的javadoc命令能提取文档注释并形成帮助文档。如，在命令窗口中使用命令“javadoc Example1_01.java”将例1.1中的文档注释提取出来。javadoc 命令执行完成后，双击文件“index.html”可以看到如图1.5所示的结果。