Java 注释的最佳实践。

java programming java8object oriented programming

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

  • 无论何时需要生成文档,都使用文档注释。
  • 多行注释用于注释掉未使用的代码。
  • 最好在代码中使用单行注释,并且它应该足够有意义,以展示业务逻辑的目的。

相关文章