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