类文件注释规约

VioletJack 发布于2019-08-19 10:28 / 1896人阅读

摘要：类文件注释规约简介为了区分作者和版本的概念以及，开发请遵守下面设置。如现在项目大版本为，创建类文件模板默认因为版本。请务必需要在注释上标注该类的使用用途测试作者如果你不是该类的创建者，要增加新的特性方法，需要在注释头部加入自己的。

类文件注释规约 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
 */

idc机房托管服务器托管 java 代码注释学生类文件注释文件注释模板通信规约

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/76066.html

阿里巴巴Java代码规约插件p3c-pmd使用指南与实现解析

摘要：年月底，阿里巴巴集团发布了阿里巴巴开发手册终极版，年月日，在杭州云栖大会上，代码规约插件全球首发，插件支持以上版本和以上版本。阿里巴巴代码规约插件安装阿里代码规约插件有插件和插件。 2017年9月底，阿里巴巴集团发布了《阿里巴巴Java开发手册》PDF终极版，2017年10月14日，在2017杭州云栖大会上，Java代码规约插件全球首发，p3c-pmd插件支持Eclipse4.2以上版...

worldligang 2019-08-15 12:20 评论0 收藏0
常识之外的规范——阿里java开发手册笔记(全章节)

摘要：说明这篇文章是我第一次认真阅读阿里巴巴开发手册终极版的笔记。说明本手册明确防止是调用者的责任。一年半载后，那么单元测试几乎处于废弃状态。好的单元测试能够最大限度地规避线上故障。说明这篇文章是我第一次（认真）阅读《阿里巴巴 Java 开发手册(终极版)》的笔记。手册本身对规范的讲解已经非常详细了，如果你已经有一定的开发经验并且有良好的编码习惯和意识，会发现大部分规范是符合常识的。所以...

Martin91 2019-08-15 12:11 评论0 收藏0
第3章：抽象数据类型（ADT）和面向对象编程（OOP） 3.2设计规约

摘要：程序失败时，很难确定错误的位置。它保护客户免受单位工作细节的影响。将前提条件放在中，并将后置条件放入和。涉及可变对象的契约现在取决于每个引用可变对象的每个人的良好行为。设计规约按规约分类比较规约它是如何确定性的。大纲 1.编程语言中的功能/方法2.规约：便于交流的编程，为什么需要规约行为等同规约结构：前提条件和后条件测试和验证规约3.设计规约分类规约图表规约质量规约4.总结编程...

mozillazg 2019-08-16 12:34 评论0 收藏0
阿里巴巴java开发手册学习记录，php版

摘要：的类型均为类型，前者现在时表示主动创建，后者过去分词表示被动更新。推荐单表行数超过万行或者单表容量超过，才推荐进行分库分表。超过三个表禁止。防止因字段类型不同造成的隐式转换，导致索引失效。说明会统计值为的行，而列名不会统计此列为值的行。一.编程规约 (一)命名风格 1.目录使用小写+下划线 home,view,model,admin_view 2.类 UpperCamelCa...

Chao 2019-07-31 18:11 评论0 收藏0
阿里巴巴java开发手册学习记录，php版

摘要：的类型均为类型，前者现在时表示主动创建，后者过去分词表示被动更新。推荐单表行数超过万行或者单表容量超过，才推荐进行分库分表。超过三个表禁止。防止因字段类型不同造成的隐式转换，导致索引失效。说明会统计值为的行，而列名不会统计此列为值的行。一.编程规约 (一)命名风格 1.目录使用小写+下划线 home,view,model,admin_view 2.类 UpperCamelCa...

wangym 2019-07-01 10:13 评论0 收藏0