這篇文章給大家分享的是有關(guān)java中類文件注釋規(guī)約的示例分析的內(nèi)容。小編覺得挺實用的，因此分享給大家做個參考，一起跟隨小編過來看看吧。

創(chuàng)新互聯(lián)基于成都重慶香港及美國等地區(qū)分布式IDC機房數(shù)據(jù)中心構(gòu)建的電信大帶寬，聯(lián)通大帶寬，移動大帶寬，多線BGP大帶寬租用,是為眾多客戶提供專業(yè)服務(wù)器托管報價，主機托管價格性價比高，為金融證券行業(yè)綿陽主機托管，ai人工智能服務(wù)器托管提供bgp線路100M獨享，G口帶寬及機柜租用的專業(yè)成都idc公司。

類文件注釋規(guī)約

1.簡介

為了區(qū)分作者和版本的概念以及，開發(fā)請遵守下面設(shè)置。 如：現(xiàn)在項目大版本為1，創(chuàng)建類文件模板默認(rèn)因為版本1。 作者名字為自己的名字，如需要在類里新增特性方法，需要在類作者上加入自己的名字。 修改小的bug不需要加入自己的名字。

2.idea模板設(shè)置

設(shè)置里：Preferences | Editor | File and Code Templatescdn.nlark.com/yuque/0/2019/png/204430/1557802550824-25113b0e-236d-4934-b08d-61c84581f25d.png"> 點擊導(dǎo)航欄Includes->列表文件File Header添加內(nèi)容保存即可。

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

3.模板內(nèi)容介紹

如下，創(chuàng)建類默認(rèn)加入類注釋頭部。（請務(wù)必需要在注釋上標(biāo)注該類的使用用途）

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

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

1).@author （作者）

如果你不是該類的創(chuàng)建者，要增加新的特性方法，需要在注釋頭部加入自己的author。 修改小的bug則不需要添加自己的author

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

2).@since（版本）

版本請和當(dāng)前項目版本大版本一致。（如：該項目為2.0版本，請在idea模板里將@since改為2.0） 項目大版本升級請更新@since版本，為了好區(qū)分類的作用以及處于項目那個版本創(chuàng)建。

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

感謝各位的閱讀！關(guān)于“java中類文件注釋規(guī)約的示例分析”這篇文章就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，讓大家可以學(xué)到更多知識，如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！