Java注释的最佳做法。

Java支持单行,多行注释和文档注释。文档注释由javadoc工具理解,可用于创建基于HTML的文档。以下是在Java中使用注释时的最佳实践。

  • 每当您希望生成其文档时,请使用文档注释。

  •  多行注释用于注释掉未使用的代码。

  • 最好在代码中使用单行注释,并且注释应该足够有意义以展示业务逻辑的目的。