名师讲坛:Java开发实战经典(第2版)
上QQ阅读APP看书,第一时间看更新

2.2 Java程序的注释

在任何编程语言中,都存在注释,注释的主要功能是让其他用户可以方便地阅读每段程序,提高程序的可读性,还可以通过注释屏蔽掉一些暂时不用的语句,等需要时直接取消掉此语句的注释即可。在Java中根据功能的不同,注释主要分为单行注释、多行注释、文档注释3种。

(1)单行注释,就是在注释内容前面加双斜线(//),Java编译器会忽略掉这部分信息。如下面语句:

(2)多行注释,就是在注释内容前面以单斜线加一个星形标记(/*)开头,并在注释内容末尾以一个星形标记加单斜线(*/)结束。当注释内容超过一行时一般使用这种方法,如下面语句:

(3)文档注释,是以单斜线加两个星形标记(/**)开头,并以一个星形标记加单斜线(*/)结束。用这种方法注释的内容会被解释成程序的正式文档,并能包含进如javadoc之类的工具生成的文档里,用以说明该程序的层次结构及方法。

提示

可以使用注释帮助用户调试代码。

用户在进行代码的开发时,如果发现某段代码可能暂时不需要的话,不用删除,最好使用注释的方式将其注释起来,这样就不会进行编译了。