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

通过优锐课的java学习分享中，我们可以看到关于使用java注释的详细解说，分享给大家参考学习。

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

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

为什么使用Java注释？

很好的做法是养成将Java注释放入源代码中的习惯，以提高自己和其他程序员的可读性和清晰度。并不总是能立即弄清楚Java代码的一个部分正在执行什么。一些解释行可以大大减少理解代码所需的时间。

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

执行意见Java代码只供人类阅读。Java编译器并不关心它们以及何时编译程序他们就跳过了。编译程序的大小和效率不会受到源代码中注释的数量的影响。

执行情况评论

执行意见有两种不同的格式：

行注：对于一行注释，键入“//”并在两个正斜杠后面加上您的注释。例如：

// this is a single line comment int guessNumber = (int) (Math.random() * 10); 

当编译器遇到两个正斜杠时，它知道它们右边的所有东西都将被视为注释。这在调试一段代码时很有用。只需从正在调试的代码行中添加注释，编译器就不会看到它：

 // this is a single line comment // int guessNumber = (int) (Math.random() * 10); 

当编译器遇到两个正斜杠时，它知道它们右边的所有东西都将被视为注释。这在调试一段代码时很有用。只需从正在调试的代码行中添加注释，编译器就不会看到它：

 // this is a single line comment // int guessNumber = (int) (Math.random() * 10); 

你还可以使用两个正斜杠作为行注释的结尾：

 // this is a single line comment int guessNumber = (int) (Math.random() * 10); // An end of line comment 

块状评论：要启动块注释，输入“/*”。正斜杠和星号之间的所有内容，即使位于不同的行，都被视为注释，直到字符“*/”结束注释为止。例如：

/* this 
 is 
 a
 block
 comment
 */
 
 /* so is this */

Javadoc评论

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

中的Javadoc注释

.java

源文件包含在起始和结束语法中，如下所示：

/**和*/...其中的每个注释都以*

将这些注释直接放在要文档化的方法、类、构造函数或任何其他Java元素之上。例如：

// myClass.java
/**
 * Make this a summary sentence describing your class.
* Here's another line.
 */
public class ​myClass
{
...
}

Javadoc集成了控制文档生成方式的各种标记。例如，

@param

标记定义方法的参数：

 /** main method
 * @param args String[]
 */​
 public static void main(String[] args)
 ​{
 ​ System.out.println("Hello World!");​
 }

Javadoc中还有许多其他标记可用，它还支持HTML标记以帮助控制输出。有关更多细节，请参阅Java文档。

使用注释的提示

不要评论太多。程序的每一行都不需要解释。如果你的程序逻辑流畅，没有意外发生，请不要感到需要添加注释。

缩进你的评论。如果 你要注释的代码行是缩进的，请确保你的注释与缩进匹配。

保持相关意见。有些程序员擅长修改代码，但出于某种原因忘记了更新注释。如果注释不再适用，则修改或删除它。

不要嵌套块评论。以下情况将导致编译器错误：

 /* this 
 is
 /* This block comment finishes the first comment */
 a
 block
 comment
 */ 

> 喜欢这篇文章的可以点个赞，欢迎大家留言评论，记得关注我，每天持续更新技术干货、职场趣事、海量面试资料等等

> 如果你对java技术很感兴趣也可以交流学习，共同学习进步。

> 不要再用"没有时间“来掩饰自己思想上的懒惰！趁年轻，使劲拼，给未来的自己一个交代

文章写道这里，欢迎完善交流。最后奉上近期整理出来的一套完整的java架构思维导图，分享给大家对照知识点参考学习。有更多JVM、Mysql、Tomcat、Spring Boot、Spring Cloud、Zookeeper、Kafka、RabbitMQ、RockerMQ、Redis、ELK、Git等Java干货