为你的JAVA代码配上类模块注释模板

2024-05-31 03:58

本文主要是介绍为你的JAVA代码配上类模块注释模板,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!


众所周知软件开发中,注释的重要性,但是频繁地写:autor, date 等信息显然是一件痛苦的事情,那么在eclipse中,有没有什么功能能帮我们做这件事情呢??


为eclipse工具修改java对应类注释的template(模板)


类注释模板的设置方法:

在eclipse / myeclipse中:菜单项Window -->  Preferences --> Java --> Code Style --> Code Template --> Comments --> Types 然后选择Edit

之后剩下的只要edit的时候写入你想要的类注释的模板便可以了


我这里提供几个我自己用的模板:


模板1:

/******************************************************************************************** 类描述:** @author: ${user}* @date: ${date} ${time}* ${tags}* @version 1.0*** Version    Date       ModifiedBy                 Content* -------- ---------    ----------         ------------------------* 1.0      ${date}       ${user}                             ********************************************************************************************/

模板1效果:

/**
 * *****************************************************************************************
 * 类描述:
 *
 * @author: 逍遥梦
 * @date: 2014-2-22 上午10:38:41
 * @version 1.0
 *
 *
 * Version    Date                ModifiedBy                 Content
 * --------        ---------               ----------                     -----------------------
 * 1.0             2014-2-22         逍遥梦                             
 *******************************************************************************************
 */


模板2(个人比较喜欢):

/**   * Simple to Introduction  * @ProjectName:  [${project_name}] * @Package:      [${package_name}]  * @ClassName:    [${type_name}]   * @Description:  [一句话描述该类的功能]   * @Author:       [${user}]   * @CreateDate:   [${date} ${time}]   * @UpdateUser:   [${user}]   * @UpdateDate:   [${date} ${time}]   * @UpdateRemark: [说明本次修改内容]  * @Version:      [v1.0] *    */



模板2效果:

/**
 * 
 * 
 * Simple to Introduction  
 * @ProjectName:  [EmpMis] 
 * @Package:      [cn.xym.empmis.service.impl]  
 * @ClassName:    [BussinessServiceImpl]   
 * @Description:  [一句话描述该类的功能]   
 * @Author:       [Administrator]   
 * @CreateDate:   [2014-2-22 上午10:56:16]   
 * @UpdateUser:   [Administrator]   
 * @UpdateDate:   [2014-2-22 上午10:56:16]   
 * @UpdateRemark: [说明本次修改内容]  
 * @Version:      [v1.0] 
 *
 */


模板3:

 /**   * * Simple To Introduction* 项目名称:  [${project_name}]* 包:        [${package_name}]    * 类名称:    [${type_name}]  * 类描述:    [一句话描述该类的功能]* 创建人:    [${user}]   * 创建时间:  [${date} ${time}]   * 修改人:    [${user}]   * 修改时间:  [${date} ${time}]   * 修改备注:  [说明本次修改内容]  * 版本:      [v1.0]   *    */



模板3效果:

/**
  * 
  * Simple To Introduction
  * 项目名称:  [EmpMis]
  * 包:       [cn.xym.empmis.service.impl]    
  * 类名称:    [BussinessServiceImpl]  
  * 类描述:    [一句话描述该类的功能]
  * 创建人:    [Administrator]   
  * 创建时间:  [2014-2-22 上午10:58:49]   
  * 修改人:    [Administrator]   
  * 修改时间:  [2014-2-22 上午10:58:49]   
  * 修改备注:  [说明本次修改内容]  
  * 版本:     [v1.0]   
  *
  */

这篇关于为你的JAVA代码配上类模块注释模板的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1017347

相关文章

HTML5的input标签的`type`属性值详解和代码示例

《HTML5的input标签的`type`属性值详解和代码示例》HTML5的`input`标签提供了多种`type`属性值,用于创建不同类型的输入控件,满足用户输入的多样化需求,从文本输入、密码输入、... 目录一、引言二、文本类输入类型2.1 text2.2 password2.3 textarea(严格

SpringBoot简单整合ElasticSearch实践

《SpringBoot简单整合ElasticSearch实践》Elasticsearch支持结构化和非结构化数据检索,通过索引创建和倒排索引文档,提高搜索效率,它基于Lucene封装,分为索引库、类型... 目录一:ElasticSearch支持对结构化和非结构化的数据进行检索二:ES的核心概念Index:

Java方法重载与重写之同名方法的双面魔法(最新整理)

《Java方法重载与重写之同名方法的双面魔法(最新整理)》文章介绍了Java中的方法重载Overloading和方法重写Overriding的区别联系,方法重载是指在同一个类中,允许存在多个方法名相同... 目录Java方法重载与重写:同名方法的双面魔法方法重载(Overloading):同门师兄弟的不同绝

Spring配置扩展之JavaConfig的使用小结

《Spring配置扩展之JavaConfig的使用小结》JavaConfig是Spring框架中基于纯Java代码的配置方式,用于替代传统的XML配置,通过注解(如@Bean)定义Spring容器的组... 目录JavaConfig 的概念什么是JavaConfig?为什么使用 JavaConfig?Jav

Java数组动态扩容的实现示例

《Java数组动态扩容的实现示例》本文主要介绍了Java数组动态扩容的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录1 问题2 方法3 结语1 问题实现动态的给数组添加元素效果,实现对数组扩容,原始数组使用静态分配

Java中ArrayList与顺序表示例详解

《Java中ArrayList与顺序表示例详解》顺序表是在计算机内存中以数组的形式保存的线性表,是指用一组地址连续的存储单元依次存储数据元素的线性结构,:本文主要介绍Java中ArrayList与... 目录前言一、Java集合框架核心接口与分类ArrayList二、顺序表数据结构中的顺序表三、常用代码手动

JAVA项目swing转javafx语法规则以及示例代码

《JAVA项目swing转javafx语法规则以及示例代码》:本文主要介绍JAVA项目swing转javafx语法规则以及示例代码的相关资料,文中详细讲解了主类继承、窗口创建、布局管理、控件替换、... 目录最常用的“一行换一行”速查表(直接全局替换)实际转换示例(JFramejs → JavaFX)迁移建

Spring Boot Interceptor的原理、配置、顺序控制及与Filter的关键区别对比分析

《SpringBootInterceptor的原理、配置、顺序控制及与Filter的关键区别对比分析》本文主要介绍了SpringBoot中的拦截器(Interceptor)及其与过滤器(Filt... 目录前言一、核心功能二、拦截器的实现2.1 定义自定义拦截器2.2 注册拦截器三、多拦截器的执行顺序四、过

Go异常处理、泛型和文件操作实例代码

《Go异常处理、泛型和文件操作实例代码》Go语言的异常处理机制与传统的面向对象语言(如Java、C#)所使用的try-catch结构有所不同,它采用了自己独特的设计理念和方法,:本文主要介绍Go异... 目录一:异常处理常见的异常处理向上抛中断程序恢复程序二:泛型泛型函数泛型结构体泛型切片泛型 map三:文

JAVA线程的周期及调度机制详解

《JAVA线程的周期及调度机制详解》Java线程的生命周期包括NEW、RUNNABLE、BLOCKED、WAITING、TIMED_WAITING和TERMINATED,线程调度依赖操作系统,采用抢占... 目录Java线程的生命周期线程状态转换示例代码JAVA线程调度机制优先级设置示例注意事项JAVA线程