注释风格(前后端通用)
一、注释类型:
1.用标准注释格式隐藏代码而不必删除它们
2.用单行注释解释实现细节
二、注释风格:
1.使用第三人称叙述的形式
2.编写独立的概述
三、注释内容:
1.每个重要的类、接口、字段和方法都编写注释
2.记得署名
四、内部注释:
1.仅添加有助于理解代码的内部注释
2.描写代码为什么这样做,而不是在做什么
3.避免使用行尾注释