java中类文件注释规约的示例分析

这篇文章给大家分享的是有关java中类文件注释规约的示例分析的内容。小编觉得挺实用的，因此分享给大家做个参考，一起跟随小编过来看看吧。

创新互联基于成都重庆香港及美国等地区分布式IDC机房数据中心构建的电信大带宽，联通大带宽，移动大带宽，多线BGP大带宽租用,是为众多客户提供专业服务器托管报价，主机托管价格性价比高，为金融证券行业绵阳主机托管，ai人工智能服务器托管提供bgp线路100M独享，G口带宽及机柜租用的专业成都idc公司。

类文件注释规约

1.简介

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

2.idea模板设置

设置里：Preferences | Editor | File and Code Templatescdn.nlark.com/yuque/0/2019/png/204430/1557802550824-25113b0e-236d-4934-b08d-61c84581f25d.png"> 点击导航栏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
 */

感谢各位的阅读！关于“java中类文件注释规约的示例分析”这篇文章就分享到这里了，希望以上内容可以对大家有一定的帮助，让大家可以学到更多知识，如果觉得文章不错，可以把它分享出去让更多的人看到吧！