本节书摘来异步社区《21天学通Java(第6版)》一书中的第2章,第2.3节,作者:【美】Rogers Cadenhead,更多章节内容可以访问云栖社区“异步社区”公众号查看。
2.3 注释
21天学通Java(第6版)
为提高程序的可读性,最有效的方式之一是使用注释。注释是程序中文本,说明了代码的作用。Java编译器在生成Java源代码文件的可执行版本时忽略注释,因此使用注释不会带来任何危害。
在Java程序中,可以使用3种不同的注释。
单行注释以两个斜杠(//)打头。从这些斜杠到行尾的所有内容都是注释,Java编译器将忽略它们,如下面的语句所示:
从这些斜杠到行尾的所有内容都被忽略,因此在编译器看来,上述代码行与下面的代码等效:
多行注释以/打头,以/结束。这两个分界符之间的所有内容都被视为注释,如下所示:
Javadoc注释以/*打头,/以结束。这些分界符之间的内容都被视为用于描述类及其方法的官方文档。
Javadoc注释可被诸如JDK工具javadoc等实用程序读取。Javadoc使用这种注释来创建一组网页,用于说明Java类的功能、指出Java类在继承层次结构中的位置、描述其每个方法。