Java注释是Java代码文件中被编译器和运行时引擎忽略的注释。它们用于注释代码，以阐明其设计和用途。您可以向Java文件添加数量不限的注释，但在使用注释时，有一些“最佳实践”需要遵循。

通常，代码注释是解释源代码的“实现”注释，例如类、接口、方法和字段的描述。这些通常是写在Java代码上方或旁边的几行代码，以阐明它的功能。

另一种类型的Java注释是Javadoc注释。Javadoc注释在语法上与实现注释稍有不同，由程序Javadoc.exe用于生成Java HTML文档。

为什么使用java注释？

养成在源代码中添加Java注释的习惯是一种很好的做法，以增强其可读性和清晰性，方便您和其他程序员阅读。Java代码的某一部分执行的内容并不总是一目了然。几行解释可以大大减少理解代码所需的时间。

它们会影响程序的运行方式吗？

Java代码中的实现注释只供人们阅读。Java编译器并不关心它们，在编译程序时，它们只是跳过它们。编译程序的大小和效率不会受到源代码中注释数量的影响。

实施意见

实施意见有两种不同的格式：

• 行注释：对于单行注释，请键入“/”，并在注释后面加上两个正斜杠。例如：//这是一行注释int guessNumber=（int）（Math.random（）*10）；当编译器遇到两个正斜杠时，它知道它们右边的所有内容都将被视为注释。这在调试一段代码时很有用。只需从正在调试的代码行中添加注释，编译器将看不到它：//这是单行注释//int guessNumber=（int）（Math.random（）*10）；您还可以使用两个正斜杠生成行末注释：//这是单行注释int guessNumber=（int）（Math.random（）*10）；//行尾评论
• 块注释：要开始块注释，请键入“/*”。正斜杠和星号之间的所有内容，即使它们位于不同的行上，都将被视为注释，直到字符“*/”结束注释。例如：/*thisisablockcomment*/*这也是*/

javadoc注释

使用特殊的Javadoc注释来记录Java API。Javadoc是JDK附带的一个工具，它从源代码中的注释生成HTML文档。

中的Javadoc注释

.java source files is enclosed in start and end syntax like so:  /** and  */. Each comment within these is prefaced with a  * Place these comments directly above the method, class, constructor or any other Java element that you want to document. For example: // myClass.java/** * Make this a summary sentence describing your class.* Here's another line. */public class ​myClass{...} Javadoc incorporates various tags that control how the documentation is generated. For example, the @param /** main method * @param args String[] */​ public static void main(String[] args) ​{ ​ System.out.println("Hello World!");​ } Many other tags are available in Javadoc, and it also supports HTML tags to help control the output. See your Java documentation for more detail.

Tips for Using Comments

• 不要过度评论。程序的每一行都不需要解释。如果您的程序在逻辑上流动，并且没有意外情况发生，则无需添加注释。
• 缩进你的评论。如果要注释的代码行缩进，请确保注释与缩进匹配。
• 保持评论的相关性。有些程序员擅长修改代码，但由于某种原因忘记了更新注释。如果注释不再适用，请修改或删除它。
• 不要嵌套块注释。以下操作将导致编译器错误：/*thisis/*此块注释完成第一条注释*/ablockcomment*/