类文件注释规约

类文件注释规约

1.简介

为了区分作者和版本的概念以及，开发请遵守下面设置。如：现在项目大版本为1，创建类文件模板默认因为版本1。作者名字为自己的名字，如需要在类里新增特性方法，需要在类作者上加入自己的名字。修改小的bug不需要加入自己的名字。

2.idea模板设置

设置里：Preferences | Editor | File and Code Templates点击导航栏Includes->列表文件File Header添加内容保存即可。

/**
 * @author <作者>
 * @since <版本>
 */

3.模板内容介绍

如下，创建类默认加入类注释头部。（请务必需要在注释上标注该类的使用用途）

/**
 * {@link RestController} Test测试Controller
 *
 * @author purgeyao
 * @since 1.0
 */
@RestController
public class TestController {

    @GetMapping("test")
    public String test(){
        return  "123";
    }
}

1).@author （作者）

如果你不是该类的创建者，要增加新的特性方法，需要在注释头部加入自己的author。修改小的bug则不需要添加自己的author

/**
 * @author purgeyao
 * @author <自己的名字>
 * @since 1.0
 */

2).@since（版本）

版本请和当前项目版本大版本一致。（如：该项目为2.0版本，请在idea模板里将@since改为2.0）项目大版本升级请更新@since版本，为了好区分类的作用以及处于项目那个版本创建。

/**
 * @author purgeyao
 * @since 2.0
 */

来源：https://blog.csdn.net/weixin_43367055/article/details/99292042