在网上看到了这个关于注释模板的介绍,个人比较喜欢彩色的、格式工整的代码,想想很多人应该都和本人一样,所以闲来无事 整理了一下
特此声明下,并非原创,版权归原创所有,原创是谁,一不得而知了
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:
文件(Files)注释标签:
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author A18ccms A18ccms_gmail_com
* @date ${date} ${time}
* @version V1.0
*/
类型(Types)注释标签(类的注释):
/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author A18ccms a18ccms_gmail_com
* @date ${date} ${time}
*
* ${tags}
*/
字段(Fields)注释标签:
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
构造函数标签:
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
方法(Constructor & Methods)标签:
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 设定文件
* @return ${return_type} 返回类型
* @throws
*/
覆盖方法(Overriding Methods)标签:
/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
代表方法(Delegate Methods)标签:
/**
* ${tags}
* ${see_to_target}
*/
getter方法标签:
/**
* @return ${bare_field_name}
*/
setter方法标签:
/**
* @param ${param} 要设置的 ${bare_field_name}
*/
例子:
view plaincopy to clipboardprint?
<?xml version="1.0" encoding="UTF-8"?>
<templates>
<template
autoinsert="false"
context="constructorcomment_context"
deleted="false"
description="Comment for created constructors"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
name="constructorcomment">
/**
* 创建一个新的实例 ${enclosing_type}.
*
* ${tags}
*/
</template>
<template
autoinsert="true"
context="settercomment_context"
deleted="false"
description="Comment for setter method"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
name="settercomment">
/**
* @param ${param} the ${bare_field_name} to set
*/
</template>
<template
autoinsert="false"
context="methodcomment_context"
deleted="false"
description="Comment for non-overriding methods"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
name="methodcomment">
/**
* 此方法描述的是:
* @author: wangxiongdx@163.com
* @version: ${date} ${time}
*/
</template>
<template
autoinsert="true"
context="delegatecomment_context"
deleted="false"
description="Comment for delegate methods"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
name="delegatecomment">
/**
* ${tags}
* ${see_to_target}
*/
</template>
<template
autoinsert="false"
context="filecomment_context"
deleted="false"
description="Comment for created Java files"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
name="filecomment">
/**
* 文件名:${file_name}
*
* 版本信息:
* 日期:${date}
* Copyright 足下 Corporation ${year}
* 版权所有
*
*/
</template>
<template
autoinsert="false"
context="gettercomment_context"
deleted="false"
description="Comment for getter method"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
name="gettercomment">
/**
* ${bare_field_name}
*
* @return the ${bare_field_name}
* @since CodingExample Ver(编码范例查看) 1.0
*/
</template>
<template
autoinsert="true"
context="overridecomment_context"
deleted="false"
description="Comment for overriding methods"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
name="overridecomment">
/* (non-Javadoc)
* ${see_to_overridden}
*/
</template>
<template
autoinsert="false"
context="fieldcomment_context"
deleted="false"
description="Comment for fields"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"
name="fieldcomment">
/**
* ${field}:${todo}(用一句话描述这个变量表示什么)
*
* @since Ver 1.1
*/
</template>
<template
autoinsert="false"
context="typecomment_context"
deleted="false"
description="Comment for created types"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.typecomment"
name="typecomment">
/**
* 此类描述的是:
* @author: wangxiongdx@163.com
* @version: ${date} ${time}
*/
</template>
</templates>
分享到:
相关推荐
### Eclipse注释模板详解与导入方法 在软件开发过程中,良好的代码注释习惯不仅能够提升代码的可读性,还能方便后期的维护和重构。Eclipse作为一款广泛使用的集成开发环境(IDE),提供了丰富的功能来支持开发者的...
**Eclipse 注释模板详解** 1. **创建和管理注释模板** 在Eclipse中,你可以通过`Window` -> `Preferences` -> `Java` -> `Code Style` -> `Code Templates`路径来访问和管理注释模板。这里分为三类:`Comments` ->...
#### 三、Eclipse Java注释模板详解 下面将对Eclipse中几种常见的注释模板进行详细说明: ##### 1. 文件注释(File Comment) 文件注释通常位于每个Java文件的开头,用于描述该文件的基本信息。示例如下: ```java...
Eclipse Java注释模板设置详解 Eclipse Java注释模板设置详解 设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一...
### Eclipse Java注释模板设置详解 在开发过程中,良好的代码注释习惯对于提高代码的可读性和维护性具有重要作用。Eclipse作为一款流行的Java集成开发环境(IDE),提供了丰富的功能来帮助开发者更好地管理代码和...
在Java开发过程中,Eclipse和MyEclipse作为两款流行的集成开发环境(IDEs),提供了许多便利的功能,其中包括自定义代码注释模板。这篇详细的教程将深入讲解如何在Eclipse和MyEclipse中设置Java注释模板,以提高开发...
编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。 下载该文件后选择右侧Import导入该文件就创建模板成功了. 可以点击每一个选项根据...
### IDEA类和方法注释模板设置知识点详解 #### 类注释模板设置 1. **模板作用** 类注释模板的作用是在创建Java类文件时,自动添加标准注释信息,从而规范代码结构,提高代码的可读性和可维护性。 2. **设置流程*...
### Eclipse 快捷键与模板详解 #### 一、引言 在软件开发过程中,工具的熟练使用能够显著提升工作效率。Eclipse作为一款强大的开源Java集成开发环境(IDE),提供了丰富的快捷键和模板功能,帮助开发者高效编写代码...
### Eclipse与MyEclipse注释规范设置详解 在软件开发过程中,良好的代码注释习惯对于提高代码可读性、维护性和团队协作效率至关重要。本文将详细介绍如何在Eclipse与MyEclipse IDE中设置规范化的注释格式,帮助...
#### 四、配置Eclipse注释模板 除了修改`GetterSetterUtil`类外,还需要调整Eclipse的注释模板设置,以确保自动生成的注释符合预期。 1. 打开Eclipse,依次点击菜单`Window -> Preferences -> Java -> Code Style ->...
Eclipse快捷键和文档注释设置详解 Eclipse是一款功能强大且广泛使用的集成开发环境(IDE),它提供了许多实用的快捷键来提高开发效率。同时,Eclipse也提供了丰富的文档注释功能,帮助开发者更好地记录和管理代码。...
按下此组合键后,Eclipse会在光标处自动插入一个Javadoc注释模板,开发者只需填写具体内容即可。 - **应用场景**:在编写公共接口、方法或其他需要文档说明的地方时使用,有助于提高代码可读性和维护性。 3. **...
这里就是我们进行代码模板自定义的地方,包括但不限于方法、类、文件的注释模板。 #### 步骤三:编辑代码模板 在“Code Templates”界面中,找到“Code”分类下的“New Java files”,点击右侧的“Edit”按钮。此时...
Eclipse 配置 Java 注释模板详解 Eclipse 是一个功能强大且广泛使用的集成开发环境(IDE),其中 Java 是其支持的主要编程语言之一。为了提高代码的可读性和可维护性,添加合适的注释是非常重要的。Eclipse 提供了...
### Eclipse自动注释功能详解 #### 一、概述 在软件开发过程中,代码注释是极为重要的一个环节,它能够帮助开发者更好地理解代码逻辑及功能实现。Eclipse作为一款广泛使用的开源集成开发环境(IDE),提供了强大的...
为了实现统一的 Java 文档注释风格,我们可以利用 Eclipse 的 Code Templates 功能来自定义注释模板。下面将详细介绍如何在 Eclipse 中配置这些模板: 1. **打开 Code Templates 配置界面** - 打开 Eclipse,依次...
### Eclipse 整合开发工具基础知识点详解 #### 一、Eclipse简介与历史背景 - **Eclipse**:是一款开源的、可扩展的集成开发环境(IDE),支持多种编程语言,如Java、C/C++、PHP等。它以其强大的插件系统著称,允许...