类文件注释规约

类文件注释规约

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
 */复制代码