Java 注释规范原则与基本要求

代码注释为代码设计者、阅读者及系统间调用提供有效帮助，能最大限度提高团队开发合作效率并增强系统的可维护性。追求简化并非为了写注释而写注释。

一、原则

1. 注释形式统一 使用统一的注释风格，不要随意创建新的注释风格。

2. 注释准确简洁 内容要简单、明了，防止注释的多义性，错误的注释不但无益反而有害。

二、注释条件

1. 基本注释（必须加）
   • 类（接口）的注释