【Java系列教程三】注释

注释

在代码中包含注释的目的是解释代码在做什么。 Java支持单行和多行注释。

Java编译器将忽略注释中出现的所有字符。 一个单行注释以两个正斜杠开头，并一直持续到行尾。

例如：

//这是单行注释

x=5；//代码后的单行注释

在编写代码时添加注释是一个很好的习惯，因为当您需要引用它时，注释可以提供澄清和理解，也可以为其他需要阅读它的人提供澄清和理解。

多行注释

Java还支持跨多行的注释。

这种类型的注释以正斜杠后跟星号开始，以星号后跟正斜杠结束。

例如：

/*这也是一个

注释跨越

多行*/

请注意，Java不支持嵌套的多行注释。

但是，可以在多行注释中嵌套单行注释。

/*这是单行注释：

//单行注释

*/

多行注释的另一个名称是块注释

文档注释

文档注释是具有多行注释外观的特殊注释，区别在于它们生成源代码的外部文档。

它们以正斜杠开头，后跟两个星号，以星号结尾，后跟一个正斜杠。

例如：

/**这是一个文档注释*/

/**这也是一个

文件注释*/

Javadoc是JDK附带的一个工具，它用于从Java源代码生成HTML格式的Java代码文档，Java源代码具有预定义格式的所需文档。

当文档注释以两个以上的星号开头时，Javadoc假设您希望在源代码中的注释周围创建一个"框"。它只是忽略了额外的星号。

例如：

/**********************

这是一种方法的开始

***********************/

这将只保留文档中的文本"这是方法的开始"。