類文件註釋規約

類文件註釋規約

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
 */