代码注释规范

1.文件注释
文件注释写在文档头部，以/*开头，例：

/ *
* 文件名：[文件名]
* 作者：〈版权〉
* 描述：〈描述〉
* 修改人：〈修改人〉
* 修改时间：YYYY-MM-DD
 * 修改内容：〈修改内容〉
  */

2.类和接口的注释
说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期

/ *
 * 〈一句话功能简述〉 
* 〈功能详细描述〉
* @author [作者]
* @version [版本号, YYYY-MM-DD]
* @see [相关类/方法]
* @since [产品/模块版本]
* @deprecated
*/

3.成员变量
注释内容：成员变量的意义、目的、功能，可能被用到的地方。用//来注释,需要对齐被注释代码。

4.公有和保护方法
注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。

注意事项：
1.边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
2.避免在注释中使用缩写，特别是不常用缩写。说明：在使用缩写时或之前，应对缩写进行必要的说明。 注释应该放在被注释的代码前面，分行展示，但中间不留空行。