代码注释是对代码设计者、代码阅读者以及系统间调用提供了有效的帮助,最大限度的提高团队开发合作效率增强系统的可维护性。我们追求简化,不是为了写注释而写注释。
(快速使用请直接看六、七、八)
一、原则:
1.注释形式统一
使用统一的注释风格,不要随意创建新的注释风格。
2.注释准确简洁
内容要简单、明了,防止注释的多义性,错误的注释不但无益反而有害。
二、注释条件:
1.基本注释(必须加)
a)类(接口)的注释
b)构造函数的注释
c)方法的注释
d)全局变量的注释
e)字段/属性的注释