为你的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

相关文章

Java中的getBytes()方法使用详解

《Java中的getBytes()方法使用详解》:本文主要介绍Java中getBytes()方法使用的相关资料,getBytes()方法有多个重载形式,可以根据需要指定字符集来进行转换,文中通过代... 目录前言一、常见重载形式二、示例代码三、getBytes(Charset charset)和getByt

Java使用Stream流的Lambda语法进行List转Map的操作方式

《Java使用Stream流的Lambda语法进行List转Map的操作方式》:本文主要介绍Java使用Stream流的Lambda语法进行List转Map的操作方式,具有很好的参考价值,希望对大... 目录背景Stream流的Lambda语法应用实例1、定义要操作的UserDto2、ListChina编程转成M

Spring框架中@Lazy延迟加载原理和使用详解

《Spring框架中@Lazy延迟加载原理和使用详解》:本文主要介绍Spring框架中@Lazy延迟加载原理和使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录一、@Lazy延迟加载原理1.延迟加载原理1.1 @Lazy三种配置方法1.2 @Component

使用easy connect之后,maven无法使用,原来需要配置-Djava.net.preferIPv4Stack=true问题

《使用easyconnect之后,maven无法使用,原来需要配置-Djava.net.preferIPv4Stack=true问题》:本文主要介绍使用easyconnect之后,maven无法... 目录使用easGWowCy connect之后,maven无法使用,原来需要配置-DJava.net.pr

idea报错java: 非法字符: ‘\ufeff‘的解决步骤以及说明

《idea报错java:非法字符:‘ufeff‘的解决步骤以及说明》:本文主要介绍idea报错java:非法字符:ufeff的解决步骤以及说明,文章详细解释了为什么在Java中会出现uf... 目录BOM是什么?1. BOM的作用2. 为什么会出现 \ufeff 错误?3. 如何解决 \ufeff 问题?最

使用Java编写一个字符脱敏工具类

《使用Java编写一个字符脱敏工具类》这篇文章主要为大家详细介绍了如何使用Java编写一个字符脱敏工具类,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1、字符脱敏工具类2、测试工具类3、测试结果1、字符脱敏工具类import lombok.extern.slf4j.Slf4j

Java实现按字节长度截取字符串

《Java实现按字节长度截取字符串》在Java中,由于字符串可能包含多字节字符,直接按字节长度截取可能会导致乱码或截取不准确的问题,下面我们就来看看几种按字节长度截取字符串的方法吧... 目录方法一:使用String的getBytes方法方法二:指定字符编码处理方法三:更精确的字符编码处理使用示例注意事项方

使用Python和PaddleOCR实现图文识别的代码和步骤

《使用Python和PaddleOCR实现图文识别的代码和步骤》在当今数字化时代,图文识别技术的应用越来越广泛,如文档数字化、信息提取等,PaddleOCR是百度开源的一款强大的OCR工具包,它集成了... 目录一、引言二、环境准备2.1 安装 python2.2 安装 PaddlePaddle2.3 安装

Python datetime 模块概述及应用场景

《Pythondatetime模块概述及应用场景》Python的datetime模块是标准库中用于处理日期和时间的核心模块,本文给大家介绍Pythondatetime模块概述及应用场景,感兴趣的朋... 目录一、python datetime 模块概述二、datetime 模块核心类解析三、日期时间格式化与

Spring三级缓存解决循环依赖的解析过程

《Spring三级缓存解决循环依赖的解析过程》:本文主要介绍Spring三级缓存解决循环依赖的解析过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、循环依赖场景二、三级缓存定义三、解决流程(以ServiceA和ServiceB为例)四、关键机制详解五、设计约