为你的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 boot整合dubbo+zookeeper的详细过程

《Springboot整合dubbo+zookeeper的详细过程》本文讲解SpringBoot整合Dubbo与Zookeeper实现API、Provider、Consumer模式,包含依赖配置、... 目录Spring boot整合dubbo+zookeeper1.创建父工程2.父工程引入依赖3.创建ap

SpringBoot结合Docker进行容器化处理指南

《SpringBoot结合Docker进行容器化处理指南》在当今快速发展的软件工程领域,SpringBoot和Docker已经成为现代Java开发者的必备工具,本文将深入讲解如何将一个SpringBo... 目录前言一、为什么选择 Spring Bootjavascript + docker1. 快速部署与

Spring Boot spring-boot-maven-plugin 参数配置详解(最新推荐)

《SpringBootspring-boot-maven-plugin参数配置详解(最新推荐)》文章介绍了SpringBootMaven插件的5个核心目标(repackage、run、start... 目录一 spring-boot-maven-plugin 插件的5个Goals二 应用场景1 重新打包应用

SpringBoot+EasyExcel实现自定义复杂样式导入导出

《SpringBoot+EasyExcel实现自定义复杂样式导入导出》这篇文章主要为大家详细介绍了SpringBoot如何结果EasyExcel实现自定义复杂样式导入导出功能,文中的示例代码讲解详细,... 目录安装处理自定义导出复杂场景1、列不固定,动态列2、动态下拉3、自定义锁定行/列,添加密码4、合并

Spring Boot集成Druid实现数据源管理与监控的详细步骤

《SpringBoot集成Druid实现数据源管理与监控的详细步骤》本文介绍如何在SpringBoot项目中集成Druid数据库连接池,包括环境搭建、Maven依赖配置、SpringBoot配置文件... 目录1. 引言1.1 环境准备1.2 Druid介绍2. 配置Druid连接池3. 查看Druid监控

Python通用唯一标识符模块uuid使用案例详解

《Python通用唯一标识符模块uuid使用案例详解》Pythonuuid模块用于生成128位全局唯一标识符,支持UUID1-5版本,适用于分布式系统、数据库主键等场景,需注意隐私、碰撞概率及存储优... 目录简介核心功能1. UUID版本2. UUID属性3. 命名空间使用场景1. 生成唯一标识符2. 数

Java中读取YAML文件配置信息常见问题及解决方法

《Java中读取YAML文件配置信息常见问题及解决方法》:本文主要介绍Java中读取YAML文件配置信息常见问题及解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要... 目录1 使用Spring Boot的@ConfigurationProperties2. 使用@Valu

创建Java keystore文件的完整指南及详细步骤

《创建Javakeystore文件的完整指南及详细步骤》本文详解Java中keystore的创建与配置,涵盖私钥管理、自签名与CA证书生成、SSL/TLS应用,强调安全存储及验证机制,确保通信加密和... 目录1. 秘密键(私钥)的理解与管理私钥的定义与重要性私钥的管理策略私钥的生成与存储2. 证书的创建与

浅析Spring如何控制Bean的加载顺序

《浅析Spring如何控制Bean的加载顺序》在大多数情况下,我们不需要手动控制Bean的加载顺序,因为Spring的IoC容器足够智能,但在某些特殊场景下,这种隐式的依赖关系可能不存在,下面我们就来... 目录核心原则:依赖驱动加载手动控制 Bean 加载顺序的方法方法 1:使用@DependsOn(最直

SpringBoot中如何使用Assert进行断言校验

《SpringBoot中如何使用Assert进行断言校验》Java提供了内置的assert机制,而Spring框架也提供了更强大的Assert工具类来帮助开发者进行参数校验和状态检查,下... 目录前言一、Java 原生assert简介1.1 使用方式1.2 示例代码1.3 优缺点分析二、Spring Fr