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

相关文章

深入浅出Spring中的@Autowired自动注入的工作原理及实践应用

《深入浅出Spring中的@Autowired自动注入的工作原理及实践应用》在Spring框架的学习旅程中,@Autowired无疑是一个高频出现却又让初学者头疼的注解,它看似简单,却蕴含着Sprin... 目录深入浅出Spring中的@Autowired:自动注入的奥秘什么是依赖注入?@Autowired

Spring 依赖注入与循环依赖总结

《Spring依赖注入与循环依赖总结》这篇文章给大家介绍Spring依赖注入与循环依赖总结篇,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录1. Spring 三级缓存解决循环依赖1. 创建UserService原始对象2. 将原始对象包装成工

Java中如何正确的停掉线程

《Java中如何正确的停掉线程》Java通过interrupt()通知线程停止而非强制,确保线程自主处理中断,避免数据损坏,线程池的shutdown()等待任务完成,shutdownNow()强制中断... 目录为什么不强制停止为什么 Java 不提供强制停止线程的能力呢?如何用interrupt停止线程s

SpringBoot请求参数传递与接收示例详解

《SpringBoot请求参数传递与接收示例详解》本文给大家介绍SpringBoot请求参数传递与接收示例详解,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋... 目录I. 基础参数传递i.查询参数(Query Parameters)ii.路径参数(Path Va

SpringBoot路径映射配置的实现步骤

《SpringBoot路径映射配置的实现步骤》本文介绍了如何在SpringBoot项目中配置路径映射,使得除static目录外的资源可被访问,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一... 目录SpringBoot路径映射补:springboot 配置虚拟路径映射 @RequestMapp

Java MCP 的鉴权深度解析

《JavaMCP的鉴权深度解析》文章介绍JavaMCP鉴权的实现方式,指出客户端可通过queryString、header或env传递鉴权信息,服务器端支持工具单独鉴权、过滤器集中鉴权及启动时鉴权... 目录一、MCP Client 侧(负责传递,比较简单)(1)常见的 mcpServers json 配置

GSON框架下将百度天气JSON数据转JavaBean

《GSON框架下将百度天气JSON数据转JavaBean》这篇文章主要为大家详细介绍了如何在GSON框架下实现将百度天气JSON数据转JavaBean,文中的示例代码讲解详细,感兴趣的小伙伴可以了解下... 目录前言一、百度天气jsON1、请求参数2、返回参数3、属性映射二、GSON属性映射实战1、类对象映

Redis实现高效内存管理的示例代码

《Redis实现高效内存管理的示例代码》Redis内存管理是其核心功能之一,为了高效地利用内存,Redis采用了多种技术和策略,如优化的数据结构、内存分配策略、内存回收、数据压缩等,下面就来详细的介绍... 目录1. 内存分配策略jemalloc 的使用2. 数据压缩和编码ziplist示例代码3. 优化的

Java Stream 并行流简介、使用与注意事项小结

《JavaStream并行流简介、使用与注意事项小结》Java8并行流基于StreamAPI,利用多核CPU提升计算密集型任务效率,但需注意线程安全、顺序不确定及线程池管理,可通过自定义线程池与C... 目录1. 并行流简介​特点:​2. 并行流的简单使用​示例:并行流的基本使用​3. 配合自定义线程池​示

从原理到实战解析Java Stream 的并行流性能优化

《从原理到实战解析JavaStream的并行流性能优化》本文给大家介绍JavaStream的并行流性能优化:从原理到实战的全攻略,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的... 目录一、并行流的核心原理与适用场景二、性能优化的核心策略1. 合理设置并行度:打破默认阈值2. 避免装箱