注释风格（前后端通用）
Posted tilmto
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了注释风格（前后端通用）相关的知识，希望对你有一定的参考价值。
注释风格（前后端通用）
一、注释类型：
1.用标准注释格式隐藏代码而不必删除它们
2.用单行注释解释实现细节
二、注释风格：
1.使用第三人称叙述的形式
2.编写独立的概述
三、注释内容：
1.每个重要的类、接口、字段和方法都编写注释
2.记得署名
1.仅添加有助于理解代码的内部注释
2.描写代码为什么这样做，而不是在做什么
3.避免使用行尾注释
以上是关于注释风格（前后端通用）的主要内容，如果未能解决你的问题，请参考以下文章
前后端分离开发,基于SpringMVC符合Restful API风格Maven项目实战（附完整Demo）！