设置java注释模板

合集下载

Eclipse中设置在创建新类时自动生成注释

Eclipse中设置在创建新类时自动生成注释

Eclipse中设置在创建新类时自动生成注释
分类:IDE 2011-10-25 17:48 57人阅读评论(0) 收藏举报方法一:Eclipse中设置在创建新类时自动生成注释
windows-->preference
Java-->Code Style-->Code Templates
code-->new Java files
编辑它
${filecomment}
${package_declaration}
/**
* @author 作者E-mail:
* @version 创建时间:${date} ${time}
* 类说明
*/
${typecomment}
${type_declaration}
方法二:
通过菜单Window->Preference 打开参数设置面板,然后选择:
Java -> Code Style -> Code Templates
在右侧选择Comments,将其中的Files项,然后选右边的"Edit",进入编辑模式:
进入编辑模式后就可以自定义注释了。

另外可以插入一些变量,如年、日期等等。

最后,确保Code -> New Java files 中有:"${filecomment}"
当然,通过“导出”和“导入”功能,你可以把自己的模板导出来在其他机器上使用。

以上是文件注释,类中的方法自动添加注释类似,对应于Files下面的Types。

Eclipse快捷键:选中你的方法后alt+shift+J。

java三种注释

java三种注释

java三种注释
java三种注释
1.java规定了三种注释⽅式:单⾏注释、多⾏注释、⽂档注释
2.单⾏注释和多⾏注释的作⽤:
对所写的程序进⾏解释和说明,增强可读性
调试所写的代码:例如对部分代码注释,进⾏运⾏来找到代码错误的地⽅
特点:单⾏注释和多⾏注释,注释的内容不参与编译
单⾏注释
格式:
class helloJava{
//单⾏注释:如下的main⽅法是程序的⼊⼝!
public static void main(String args[]){
//单⾏注释:如下的语句表⽰输出到控制台
System.out.println("Hello World!");
}
}
多⾏注释
格式:
/*
这⾥是多⾏注释
*/
⽂档注释(java特有)
格式:
/**
@author 指定java程序的作者
@version 指定源⽂件的版本
*/
注释内容可以被JDK提供的⼯具Javadoc所解析,⽣成⼀套以⽹页⽂件形式体现的该程序的说明⽂档命令: javadoc -d Myjavadoc -author -version 1.2注释.java
解释:命令⾏格式为Javadoc -d ⽂件夹名字 -author -version ⽂件名.Java
⽂件夹是⾃⼰随便起的,会被放在与Java⽂件相同的⽂件⽬录下。

注意:多⾏注释不能够嵌套使⽤。

idea 2021设置标准的 javadoc注释

idea 2021设置标准的 javadoc注释

一、概述在开发软件项目的过程中,代码的注释是至关重要的。

好的注释能够提高代码的可读性和可维护性,同时也有利于团队协作和知识传承。

在Java编程语言中,Javadoc是一种非常常见的注释规范,它能够帮助开发人员生成文档,并且规范了注释的格式和内容。

二、Javadoc注释的重要性1. 提高代码可读性:使用Javadoc规范的注释能够使代码更易于阅读,开发人员能够快速了解每个方法、类的功能和用法。

2. 方便文档生成:Javadoc注释可以用来生成项目的API文档,这样就能够方便地为其他开发人员提供项目的说明文档。

3. 促进团队合作:Javadoc规范的注释能够让团队成员更容易地理解和使用彼此编写的代码,有利于团队合作和项目进展。

三、Javadoc注释的基本格式在编写Javadoc注释时,需要遵循一定的格式和规范。

一般来说,Javadoc注释由三部分构成:描述、标签、文档注释。

1. 描述:描述中应包括对方法、类、变量等内容的简要介绍,以及其作用、参数、返回值等信息。

2. 标签:标签是以开头的关键字,包含在描述之后,用以标识注释的类型和内容,例如param、return等。

3. 文档注释:文档注释是由描述和标签组成的完整注释整体,用以说明代码的作用和用法。

四、Javadoc注释的最佳实践1. 每一个方法都要有Javadoc注释:对于每一个方法都应该编写清晰的Javadoc注释,包括描述、参数、返回值等信息。

2. 遵循标准格式:在编写Javadoc注释时,应该尽量遵循Javadoc的标准格式和命名约定,保持统一和规范。

3. 及时更新注释:随着代码的更新和修改,Javadoc注释也需要随之进行更新,以保持文档的及时性和准确性。

五、IDEA 2021中设置Javadoc注释在IDEA 2021中,设置Javadoc注释可以帮助开发人员自动创建和维护Javadoc注释,提高开发效率和注释的准确性。

1. 打开IDEA的设置:在IDEA中选择File -> Settings -> Editor -> Code Style -> Java,在右侧的Javadoc标签页下可以进行Javadoc 注释格式的设置。

idea多行注释模板

idea多行注释模板

idea多行注释模板在编程中,注释是一个非常重要的部分,它可以让我们更好地了解程序的逻辑和思路,还能方便后续的维护和修改。

而在注释中,多行注释是一种非常常见的形式,它可以在代码中间隔开一段注释内容,更加清晰明了。

那么,在多行注释中,如何使用idea来快速生成注释模板呢?步骤一:打开idea并创建一个测试文件首先,我们需要打开idea并在其中创建一个测试文件。

在编辑器中,我们可以使用Ctrl+N快捷键,或者通过File -> New -> Java Class等菜单来创建一个Java类文件,并命名为Test。

步骤二:快速生成多行注释在编辑器中,我们需要在Test类的某个方法中输入多行注释。

例如,我们可以在main方法中输入以下注释:/*** 这个方法是主方法,* 在程序启动的时候会首先被执行,* 它负责启动整个程序,* 并调用其他模块的方法。

*/在输入完这段注释后,我们只需要使用Ctrl+Shift+/快捷键,或者通过Code -> Surround with... -> Block comment等菜单,来快速将该注释字符串用/*和*/包围起来,完成多行注释的生成。

步骤三:引入注释模板当我们需要多次使用相同的注释模板时,我们可以将其保存为一个模板,方便后续的使用。

这可以通过在代码编辑器中设置代码模板实现。

具体步骤如下:1. 在idea的Settings -> Editor -> Live Templates中,点击Java选项卡;2. 在Java选项卡中,点击右上角的“+”按钮,新增一个代码模板;3. 在代码模板的配置页面中,设置Abbreviation为comment,并在Template Text中输入以下内容:/*** $END$*/注意:$END$是一个占位符,表示光标在该位置时,代码模板将被执行。

4. 点击Save按钮,保存配置后关闭页面。

步骤四:使用注释模板在配置好注释模板之后,我们就可以在代码编辑器中快速生成多行注释了。

idea 编辑注释格式

idea 编辑注释格式

在IntelliJ IDEA中,你可以按照以下步骤设置和编辑注释格式:1. 打开IntelliJ IDEA,点击顶部菜单栏的"File"(文件)。

2. 在下拉菜单中选择"Settings"(设置)或者直接使用快捷键"Ctrl + Alt + S"(Windows/Linux)或"Cmd + ,"(Mac)。

3. 在左侧的设置面板中,找到并点击"Editor"(编辑器)。

4. 在"Editor"(编辑器)下,点击"Code Style"(代码风格)。

5. 在"Code Style"(代码风格)下,选择你正在使用的编程语言。

例如,如果你正在编写Java代码,就选择"Java"。

6. 在右侧的设置面板中,点击"Documentation Comment"(文档注释)选项卡。

在这里,你可以根据需要配置注释的格式,包括:注释的开头和结尾标记。

是否在新的一行开始注释。

是否自动添加@author、@version等标签。

注释的对齐方式等。

7. 对于一些特定的语言,如Java,你还可以点击"Other"(其他)选项卡,然后在"Line comment at first column"(第一列的行注释)和"Block comment at first column"(第一列的块注释)选项中设置注释的格式。

8. 设置完成后,点击右下角的"OK"(确定)按钮保存你的更改。

现在,当你在IntelliJ IDEA 中编写注释时,它将自动应用你所设置的格式。

如果你想手动调整某个注释的格式,可以选中该注释,然后使用代码格式化快捷键"Ctrl + Alt + L"(Windows/Linux)或"Cmd + Option + L"(Mac)。

java文档注释规范(一)

java文档注释规范(一)

java⽂档注释规范(⼀)https:///huangsiqian/article/details/82725214Javadoc⼯具将从四种不同类型的“源”⽂件⽣成输出⽂档:Java语⾔类的源⽂件(.java),包注释⽂件,概述注释⽂件和其他未处理的⽂件。

包注释⽂件(Package Comment File)每个包都有⾃⼰的⽂档注释。

有两种⽅式来创建包注释⽂件:package-info.java - 可以包含包的声明,包注解(anotation),包注释和Javadoc 标签(tag)。

包注释放在包声明之前。

这是JDK 5.0新引⼊的特性。

如下。

File: java/applet/package-info.java 注意:⽂档注释块内部⾏⾸的*号是可选的/*** Provides the classes necessary to create an applet and the classes an applet uses* to communicate with its applet context.* <p>* The applet framework involves two entities:* the applet and the applet context. An applet is an embeddable window (see the* {@link java.awt.Panel} class) with a few extra methods that the applet context* can use to initialize, start, and stop the applet.** @since 1.0* @see java.awt*/package ng.applet;package.html - 只能包含包注释和Javadoc标签,不能包含包注解。

java自定义注解在excel导出时的使用

java自定义注解在excel导出时的使用

java自定义注解在excel导出时的使用在Java中,自定义注解是一种用于在程序中进行标记的机制。

通过定义自己的注解,可以为类、方法、字段等元素添加元数据,用于描述它们的特性和行为。

在Excel导出时,自定义注解可以用来定义导出的字段和格式,并且可以通过反射机制来读取注解信息,实现自动导出的功能。

下面是一个简单的自定义注解示例:```javaimport ng.annotation.*;String name( default ""; // 导出字段的名称int width( default 20; // 导出字段的宽度String format( default ""; // 导出字段的格式```定义了注解之后,可以在需要导出的类中使用该注解对字段进行标记。

例如:```javapublic class Userprivate String name;private int age;//其他字段和方法...```接下来,可以编写一个用于导出Excel的工具类。

该类可以使用反射来读取类的字段和注解信息,并根据注解信息生成相应的Excel文件。

以下是一个简单的Excel导出工具类示例:```javapublic class ExcelExportUtilpublic static <T> void exportToExcel(List<T> data, Class<T> clazz, String filePath)//创建工作簿和工作表Workbook workbook = new HSSFWorkbook(;Sheet sheet = workbook.createSheet("Sheet1");//获取类的字段和注解信息Field[] fields = clazz.getDeclaredFields(;for (int i = 0; i < fields.length; i++)Field field = fields[i];ExcelField excelField =field.getAnnotation(ExcelField.class);if (excelField != null)//获取注解信息String fieldName = (;int width = excelField.width(;//设置列宽sheet.setColumnWidth(i, width * 256);//创建表头单元格Row headerRow = sheet.getRow(0);if (headerRow == null)headerRow = sheet.createRow(0);}Cell headerCell = headerRow.createCell(i); headerCell.setCellValue(fieldName);}}//创建数据行for (int i = 0; i < data.size(; i++)T item = data.get(i);Row dataRow = sheet.getRow(i + 1);if (dataRow == null)dataRow = sheet.createRow(i + 1);}for (int j = 0; j < fields.length; j++)Field field = fields[j];if (field.isAccessible()try//获取字段值Object value = field.get(item);//创建数据单元格并填充数据Cell dataCell = dataRow.createCell(j); if (value instanceof String) dataCell.setCellValue((String) value); } else if (value instanceof Integer) dataCell.setCellValue((int) value);} else if (value instanceof Double) dataCell.setCellValue((double) value); }} catch (IllegalAccessException e)e.printStackTrace(;}}}}// 保存Excel文件try (FileOutputStream outputStream = newFileOutputStream(filePath))workbook.write(outputStream);} catch (IOException e)e.printStackTrace(;}}```在上面的示例中,exportToExcel方法接收一个泛型列表和类的字节码对象,通过反射来读取类的字段和注解信息,并根据注解信息生成Excel文件。

idea中live template创建自定义方法注释

idea中live template创建自定义方法注释

idea中live template创建自定义方法注释## IDEA中Live Template创建自定义方法注释IntelliJ IDEA(简称IDEA)是一款广受Java开发者欢迎的集成开发环境,其强大的代码自动补全和模板功能大大提高了开发效率。

其中,Live Template功能让开发者能够自定义代码模板,以便在编写代码时快速插入预定义的代码片段。

下面,我们将详细介绍如何在IDEA中创建自定义的方法注释Live Template。

### 导语在软件开发中,良好的注释习惯对于代码的可读性和维护性至关重要。

利用IDEA的Live Template功能,我们可以快速生成标准化的方法注释,节省时间并保持代码风格的统一。

### 创建自定义方法注释的步骤#### 1.打开Template Group设置- 在IDEA中,依次点击`File > Settings > Editor > Live Templates`。

- 在右侧,你可以看到已有的模板组。

如果要创建新的模板组,点击`+`号,选择`Group...`,输入新组的名称,例如“Custom Comments”。

#### 2.创建新的模板- 在你刚刚创建的模板组内,点击`+`号,选择`Template Group...`创建新的模板。

- 输入模板名称,例如“methodComment”,并定义适用的上下文,例如选择`Java`。

#### 3.编辑模板内容- 在Template text区域,输入你的模板内容。

以下是一个方法注释的示例模板:```java/*** $METHOD_NAME$** $DESCRIPTION$** @param $PARAMS$* @return $RETURN$* @throws $EXCEPTIONS$*/```- 在这个模板中,`$METHOD_NAME$`、`$DESCRIPTION$`、`$PARAMS$`、`$RETURN$`和`$EXCEPTIONS$`是变量,它们会在插入模板时被替换。

IDEAJava类注释、方法注释模板(可实现自动参数使用生成)

IDEAJava类注释、方法注释模板(可实现自动参数使用生成)

IDEAJava类注释、⽅法注释模板(可实现⾃动参数使⽤⽣成)JAVA 类⽂件注释设置设置地⽅:模板1/**2 * <p>3 * $description4 * </p>5 *6 * @author Tophua7 * @since ${DATE}8*/⽅法注释:配合模板和参数可实现0参和多参的⽅法模板新增,然后编辑写⼊模板和脚本。

先增模板组,再增模板(先2后1)模板:*** <p>** </p>* $param$ $return$* @author Tophua* @since $date$*/点击右边按钮添加脚本按钮点击详情参数(param)脚本1 groovyScript("def result='\\n'; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] == '') return ' '; result+=' * @param ' + params[i] + ' ' + params[i] + ((i < params.size() - 1) ? ' \\n' : ' ')}; re参数(return)脚本,两个都可以,根据需求选择使⽤脚本可过滤void返回⽣成->只有有实际返回类型才回⽣成@return脚本1 :返回全量⽅法返回类型(包括包名和泛型)1 groovyScript("def param=\"${_1}\"; if(param == '' || param == 'void') return ''; return ' \\n * @return ' + param", methodReturnType())脚本2:返回简洁⽅法返回类型(⽆包名⽆泛型,只有简单的主要类型)1 groovyScript("def param=\"${_1}\"; if(param == '' || param == 'void') return ''; param = param.replaceAll('<.*>', ''); param = param.substring(stIndexOf('.') + 1); return '\\n * @return ' + param", methodReturnType())添加使⽤范围⿏标右键选择如图位置或点击下⾯快捷地⽅勾选java完成配置使⽤:在⽅法上键⼊ /* + tab键即可⽣成。

idea创建JAVAClass时自动生成头部文档注释的方法

idea创建JAVAClass时自动生成头部文档注释的方法

idea创建JAVAClass时⾃动⽣成头部⽂档注释的⽅法IDEA设置⽂档注释模板
创建Class⽂件时⾃动⽣成的头部注释如图
如何配置idea的头部注释格式,可以⽣成像之前的注释格式⼀样的⽂档注释?
File->settings->Editor->File and Code Templates->Files->Class
原先模板
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
public class ${NAME} {
}
修改后模板
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
/**
\* Created with IntelliJ IDEA.
\* @author: xiyue
\* Date: ${DATE}
\* Time: ${TIME}
\* To change this template use File | Settings | File Templates.
\* Description:
\*/
public class ${NAME} {
}
到此这篇关于idea创建JAVA Class时⾃动⽣成头部⽂档注释的⽅法的⽂章就介绍到这了,更多相关idea⽣成头部⽂档注释内容请搜索以前的⽂章或继续浏览下⾯的相关⽂章希望⼤家以后多多⽀持!。

idea java 多行注释

idea java 多行注释

一、概述在Java编程语言中,注释是一种非常重要的语法元素,用于向程序的读者解释代码的作用,或者是临时屏蔽某些代码片段。

Java中有单行注释和多行注释两种方式,本文将重点介绍多行注释的使用方法和相关注意事项。

二、多行注释的格式多行注释是指可以跨越多行的注释形式,在Java中使用/*和*/包括起来的内容即为多行注释。

其格式如下:/*这是一段多行注释可以跨越多行*/三、多行注释的使用场景多行注释主要用于以下几种情况:1. 对代码进行较为详细的注释说明,方便程序的阅读与理解。

2. 临时屏蔽一段代码,调试程序或查找错误时使用,相比于单行注释更加便利。

3. 用于生成文档,许多Java文档生成工具可以自动提取多行注释的内容,生成类、方法等的说明文档。

四、多行注释的注意事项在使用多行注释时,需要注意以下几点:1. 多行注释不能嵌套,即/* */之间不能再包含/* */形式的注释内容。

这可能导致编译错误。

2. 多行注释不能出现在字符串常量中,否则编译器也会发出错误提示。

3. 多行注释不能出现在代码中的任何位置,只能以注释的形式独立存在,不能与代码混合在一起。

五、多行注释的最佳实践在实际的Java编程中,应该遵循以下几点关于多行注释的最佳实践:1. 注释要简洁明了,不要写过多无用的注释,遵循“必要的注释”原则。

2. 注释内容应该符合代码的逻辑结构,能够清晰地表达代码的意图。

3. 对于一些复杂算法或者特殊处理逻辑,应当使用多行注释进行详细说明,方便后续的维护和理解。

六、多行注释的案例下面是一个使用多行注释的实际案例,展示了多行注释在Java中的使用方法:/*这是一个计算斐波那契数列的方法参数n代表数列的长度返回一个长度为n的斐波那契数列数组*/public int[] fibonacci(int n) {int[] result = new int[n];result[0] = 0;result[1] = 1;for (int i = 2; i < n; i++) {result[i] = result[i - 1] + result[i - 2];}return result;}七、总结多行注释在Java中是一种非常重要的语法元素,能够帮助开发者、维护者更好地理解和阅读代码。

编码规范系列(一):EclipseCodeTemplates设置

编码规范系列(一):EclipseCodeTemplates设置

编码规范系列(⼀):EclipseCodeTemplates设置俗话说约定优于配置,但是在执⾏过程中往往发现效果不是很好(主要是指编码规范这⼀⽅⾯)。

所以我们不得不采取⼀些措施来协助我们统⼀项⽬开发⼈员的编码风格。

主要包括三个⽅⾯:设置Code Templates、Eclipse formatter、Checkstyle,本篇主要介绍如何设置Code Templates,具体步骤如下:打开Window->Preferences->Java->Code Style->Code Templates点击"Import",导⼊模板codetemplates.xml⽂件。

codetemplates.xml内容是我们⾃⼰预先定义好的,在这⾥先不详细描述,我们可以看到Eclipse Code Templates界⾯中间Configure generated code and comments区域包含了两个菜单树:Comment、Code,如下图所⽰:Comments代表注释模板,Code代表代码模板,其中每⼀个⼦菜单代表⼦项的模板。

我们只要点击某⼀个⼦项,就会在界⾯下⽅的Pattern区域看到该项我们所定义的模板内容和格式,如下图所⽰:如上图所⽰,当我们点击Comments下的Files⼦菜单时,下⾯的Pattern会显⽰Java⽂件的头部注释。

下⾯详细列出每⼀个⼦项的模板格式:Comments-->Files(Java⽂件注释)1. /**2. * Project Name:${project_name}3. * File Name:${file_name}4. * Package Name:${package_name}5. * Date:${date}${time}6. * Copyright (c) ${year}, chenzhou1025@ All Rights Reserved.7. *8. */Comments-->Types(Java类注释)1. /**2. * ClassName: ${type_name} <br/>3. * Function: ${todo} ADD FUNCTION. <br/>4. * Reason: ${todo} ADD REASON(可选). <br/>5. * date: ${date} ${time} <br/>6. *7. * @author ${user}8. * @version ${enclosing_type}${tags}9. * @since JDK 1.610. */Comments-->Fields(类字段注释)1. /**2. * ${field}:${todo}(⽤⼀句话描述这个变量表⽰什么).3. * @since JDK 1.64. */Comments-->Constructors(构造函数注释)1. /**2. * Creates a new instance of ${enclosing_type}.3. *4. * ${tags}5. */Comments-->Methods(Java⽅法注释)1. /**2. * ${enclosing_method}:(这⾥⽤⼀句话描述这个⽅法的作⽤). <br/>3. * ${todo}(这⾥描述这个⽅法适⽤条件 – 可选).<br/>4. * ${todo}(这⾥描述这个⽅法的执⾏流程 – 可选).<br/>5. * ${todo}(这⾥描述这个⽅法的使⽤⽅法 – 可选).<br/>6. * ${todo}(这⾥描述这个⽅法的注意事项 – 可选).<br/>7. *8. * @author ${user}9. * ${tags}10. * @since JDK 1.611. */Comments-->Overriding methods(重写⽅法注释)1. /**2. * ${todo} 简单描述该⽅法的实现功能(可选).3. * ${see_to_overridden}4. */Comments-->Delegate methods(代理⽅法注释)1. /**2. * ${tags}3. * ${see_to_target}4. */Comments-->Getters(Java Getter⽅法注释)1. /**2. * ${bare_field_name}.3. *4. * @return the ${bare_field_name}5. * @since JDK 1.66. */Comments-->Setters(Java Setters⽅法注释)1. /**2. * ${param}.3. *4. * @param ${param} the ${bare_field_name} to set5. * @since JDK 1.66. */Code-->New Java files(新建java⽂件代码模板)1. /**2. * Project Name:${project_name}3. * File Name:${file_name}4. * Package Name:${package_name}5. * Date:${date}${time}6. * Copyright (c) ${year}, chenzhou1025@ All Rights Reserved.7. *8. */9. ${filecomment}10.11. ${package_declaration}12. /**13. * ClassName:${type_name} <br/>14. * Function: ${todo} ADD FUNCTION. <br/>15. * Reason: ${todo} ADD REASON. <br/>16. * Date: ${date} ${time} <br/>17. * @author ${user}18. * @version19. * @since JDK 1.620. * @see21. */22. ${typecomment}23. ${type_declaration}Code-->Method body(⽅法体模板)1. // ${todo} Auto-generated method stub2. ${body_statement}Code-->Constructor body(构造函数模板)1. ${body_statement}2. // ${todo} Auto-generated constructor stubCode-->Getter body(字段Getter⽅法模板)1. return ${field};Code-->Setter body(字段Setter⽅法模板)1. ${field} = ${param};Code-->Catch block body(异常catch代码块模板)1. // ${todo} Auto-generated catch block2. ${exception_var}.printStackTrace();其中codetemplates.xml内容如下:1. <?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="false" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.tex2. * ${bare_field_name}.3. *4. * @return the ${bare_field_name}5. * @since JDK 1.66. */</template><template autoinsert="false" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.tex7. * ${param}.8. *9. * @param ${param} the ${bare_field_name} to set10. * @since JDK 1.611. */</template><template autoinsert="false" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id12. * Creates a new instance of ${enclosing_type}.13. *14. * ${tags}15. */16. </template><template autoinsert="false" context="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text17. * Project Name:${project_name}18. * File Name:${file_name}19. * Package Name:${package_name}20. * Date:${date}${time}21. * Copyright (c) ${year}, chenzhou1025@ All Rights Reserved.22. *23. */</template><template autoinsert="false" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.c24. * ClassName: ${type_name} &lt;br/&gt;25. * Function: ${todo} ADD FUNCTION. &lt;br/&gt;26. * Reason: ${todo} ADD REASON(可选). &lt;br/&gt;27. * date: ${date} ${time} &lt;br/&gt;28. *29. * @author ${user}30. * @version ${enclosing_type}${tags}31. * @since JDK 1.632. */</template><template autoinsert="false" context="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetem33. * ${field}:${todo}(⽤⼀句话描述这个变量表⽰什么).34. * @since JDK 1.635. */</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">/**36. * ${enclosing_method}:(这⾥⽤⼀句话描述这个⽅法的作⽤). &lt;br/&gt;37. * ${todo}(这⾥描述这个⽅法适⽤条件 – 可选).&lt;br/&gt;38. * ${todo}(这⾥描述这个⽅法的执⾏流程 – 可选).&lt;br/&gt;39. * ${todo}(这⾥描述这个⽅法的使⽤⽅法 – 可选).&lt;br/&gt;40. * ${todo}(这⾥描述这个⽅法的注意事项 – 可选).&lt;br/&gt;41. *42. * @author ${user}43. * ${tags}44. * @since JDK 1.645. */</template><template autoinsert="false" context="overridecomment_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.46. * ${todo} 简单描述该⽅法的实现功能(可选).47. * ${see_to_overridden}48. */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="Comment for delegate methods" enabled="true" id="org.eclipse.jd49. * ${tags}50. * ${see_to_target}51. */</template><template autoinsert="false" context="newtype_context" deleted="false" description="Newly created files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplate52. * Project Name:${project_name}53. * File Name:${file_name}54. * Package Name:${package_name}55. * Date:${date}${time}设置Code Templates的⽬的主要是为了统⼀各种注释的格式以及代码的模板,只要设定好Code Templates之后利⽤Eclipse就可以⽅便地⽣成我们⾃定义的注释,开发⼈员也容易接受!。

idea类的注释模板

idea类的注释模板

idea类的注释模板在IntelliJ IDEA中,你可以使用文件头注释模板和类注释模板,以便在创建新类或文件时自动生成注释。

以下是在IDEA中设置这些注释模板的步骤:文件头注释模板:1. 打开IntelliJ IDEA。

2. 转到"File" > "Settings"(Windows/Linux)或"IntelliJ IDEA" > "Preferences"(macOS)。

3. 在设置窗口中,选择"Editor" > "File and Code Templates"。

4. 在"Files" 选项卡下,选择"Includes" 列表中的"File Header"。

5. 在右侧的编辑区域中,你可以定义文件头注释的模板。

例如:```java/*** Description: ${DESCRIPTION}** @author ${USER}* @date ${DATE}* @time ${TIME}*/```在模板中,`${DESCRIPTION}`、`${USER}`、`${DATE}`、`${TIME}` 等是占位符,IntelliJ IDEA 会根据实际情况替换这些占位符。

类注释模板:1. 在"Files" 选项卡下,选择"Includes" 列表中的"File Header.java"。

2. 在右侧的编辑区域中,你可以定义Java类的注释模板。

例如:```java#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end#if (${IMPORT_BLOCK} && ${IMPORT_BLOCK} != "")${IMPORT_BLOCK}#end#if (${VISIBILITY} == "DEFAULT")class ${NAME} #else${VISIBILITY} ${NAME} #end#if (${SUPERCLASS} && ${SUPERCLASS} != "") extends ${SUPERCLASS} #end#if (${INTERFACES} && ${INTERFACES} != "") implements ${INTERFACES} #end{${BODY}}```同样,`${PACKAGE_NAME}`、`${IMPORT_BLOCK}`、`${VISIBILITY}`、`${NAME}` 等是占位符。

idea快速生成自定义方法注释

idea快速生成自定义方法注释

idea快速生成自定义方法注释自定义方法注释:Idea 的快捷利器在 Java 开发中,方法注释是记录方法行为、参数和返回值的重要工具。

IntelliJ IDEA 提供了一个便捷的功能,可帮助您快速生成符合规范的自定义方法注释。

采用此功能,您只需几步即可创建清晰且有帮助的方法文档。

步骤 1:插入注释模板首先,将光标定位到要注释的方法上。

然后,使用快捷键Alt+Insert,或右键单击方法并选择 Generate > Method Comment。

步骤 2:选择模板IDEA 提供了几个预定义的评论模板选项。

选择最适合您代码样式和项目的模板。

例如:`javadoc`:为方法生成标准 Javadoc 注释。

`@@param`:在方法参数上生成 `@param` 注释。

`@@return`:在方法返回值处生成 `@return` 注释。

步骤 3:自定义模板选择模板后,您可以在注释文本中编辑和添加内容。

IDEA 支持使用标记来插入动态信息,例如方法名称、参数名称和返回值类型。

步骤 4:插入位置默认情况下,注释将插入到方法的开头。

但是,您可以通过在注释文本中使用 `@Override` 或 `@Implements` 标记,将注释插入到继承或实现方法之前。

步骤 5:格式化注释IDEA 自动格式化生成的注释,使其符合约定和一致的样式。

这有助于确保您的代码文档的整洁性和可读性。

除了这些基本步骤外,您还可以:使用 Tab 键在注释标记之间切换。

使用 Enter 键创建新行。

通过编辑 Settings > Editor > Code Style > Java > Code Generation > Method Comment Generation 来自定义默认注释模板。

自定义注释格式除了内置模板外,您还可以创建自己的自定义注释格式。

为此,请在 Settings > Editor > Code Style > Java > CodeGeneration > Method Comment Generation 中添加新模板。

自定义注解用法

自定义注解用法

自定义注解用法自定义注解是Java语言提供的一种元编程特性,可以用来给代码添加额外的元数据或标记,以便在运行时进行解析和处理。

下面简单介绍一下自定义注解的用法:1.定义注解自定义注解使用@interface关键字进行定义,示例如下:javapublic@interfaceMyAnnotation{Stringvalue()default"";intcount();}注解中可以定义多个成员变量,成员变量使用方法的形式进行定义,并且可以指定默认值。

2.使用注解自定义注解可以用于类、方法、字段等目标上,使用时通过@注解名进行标注。

示例如下:java@MyAnnotation(count=5)publicclassMyClass{@MyAnnotation(value="hello",count=3)privateStringname;@MyAnnotation(count=2)publicvoidprint(){//TODO:实现打印逻辑}}上述示例中,MyClass类上使用了@MyAnnotation注解,指定了count的值为5。

name字段上也使用了@MyAnnotation注解,指定了value的值为"hello",count的值为3。

print方法上使用了@MyAnnotation注解,指定了count的值为2。

3.解析注解在程序运行时,可以通过反射机制来解析注解,获取注解中的成员变量的值。

示例如下:javaClass<?>clazz=MyClass.class;MyAnnotationclassAnnotation=clazz.getDeclaredA nnotation(MyAnnotation.class);intcount1=classAnnotation.count();//获取类上注解中count的值Fieldfield=clazz.getDeclaredField("name");MyAnnotationfieldAnnotation=field.getDeclaredA nnotation(MyAnnotation.class);Stringvalue=fieldAnnotation.value();//获取字段上注解中value的值intcount2=fieldAnnotation.count();//获取字段上注解中count的值Methodmethod=clazz.getDeclaredMethod("print");MyAnnotationmethodAnnotation=method.getDecl aredAnnotation(MyAnnotation.class);intcount3=methodAnnotation.count();//获取方法上注解中count的值上述代码示例中,通过反射机制获取到了类上、字段上、方法上的@MyAnnotation注解对象,并分别获取了注解中成员变量的值。

java 标准的方法注释模板

java 标准的方法注释模板

java 标准的方法注释模板全文共四篇示例,供读者参考第一篇示例:在Java编程过程中,良好的代码注释是至关重要的。

它不仅能够帮助其他开发人员理解你的代码,还可以让你自己在日后回顾代码时更容易理解和修改。

对于方法的注释尤为重要,因为方法是代码的基本组成部分,它完成特定的功能并可以被其他代码调用。

为了帮助开发人员编写规范的方法注释,可以制定一份Java标准的方法注释模板。

这份模板应当包含以下几个方面的内容,以确保注释信息的完整性和易读性:1. 方法的作用和功能描述:在方法注释的开头部分,应当简要描述该方法的作用和功能。

这样其他开发人员就能够清楚地了解该方法的用途,从而更好地使用或修改该方法。

2. 输入参数说明:列出该方法接收的所有参数,并对每个参数进行详细的说明。

包括参数的名称、类型、作用以及可能的取值范围等信息。

这样可以帮助其他开发人员正确地传入参数并理解参数的含义。

3. 返回值说明:说明该方法的返回值类型以及可能的返回值。

还可以说明在什么情况下会返回特定的数值或对象。

这对开发人员了解方法的返回结果非常有帮助。

4. 异常处理说明:如果该方法会抛出异常,应当在注释中明确列出可能会发生的异常类型以及每种异常的出现条件。

这能够帮助其他开发人员处理异常情况或者进行适当的异常捕获和处理。

5. 使用示例:还可以在注释中提供一个简单的使用示例,演示该方法如何调用和使用。

这样其他开发人员可以更直观地了解该方法的使用方法。

通过以上几点内容的规范注释,可以使方法注释更加清晰、易读,并且具有一致性。

这样不仅可以方便其他开发人员理解和使用你的代码,还可以提高代码的可维护性和可读性。

注释是良好编程实践的重要组成部分,能够提高代码的质量和可维护性。

编写规范的方法注释模板是一个好的开始,可以使代码更易于理解和维护。

希望上述的方法注释模板能够帮助Java开发人员编写更规范、更易读的代码注释。

第二篇示例:Java是一种流行的编程语言,具有强大的灵活性和可扩展性。

Java注释模板

Java注释模板

Java注释模板/**** 项⽬名称:${project_name}* 类名称:${type_name}* 类描述:* 创建⼈:${user}* 创建时间:${date} ${time}* 修改⼈:${user}* 修改时间:${date} ${time}* 修改备注:* @version**/----------------------------------------------------------------------------------------------------------设置注释模板的⼊⼝: 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}*//*** @param ${param} 要设置的 ${bare_field_name}*/简单模板例⼦:view plaincopy to clipboardprint?<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/*** @Fields ${field} : ${todo}(⽤⼀句话描述这个变量表⽰什么)*/</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter ⽅法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/*** @return ${bare_field_name}*/</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/*** <p>Title:${file_name} </p>* <p>Description: 构造函数</p>* ${tags}*/</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java ⽂件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/*** @Title: ${file_name}* @Package ${package_name}* @Description: ${todo}(⽤⼀句话描述该⽂件做什么)* @author DAIGUANGJIU* @date ${date} ${time}* @version V1.0*/</template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter ⽅法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/*** @param ${param} 要设置的 ${bare_field_name}*/</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/*** @author ${user}** ${tags}* ${tags}* ${see_to_target}*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖⽅法的注释"enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (⾮ Javadoc)* <p>Title: ${enclosing_method}</p>* <p>Description: </p>* ${tags}* ${see_to_overridden}*/</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="⾮覆盖⽅法的注释"enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/*** ${tags}*/</template></templa<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/*** @Fields ${field} : ${todo}(⽤⼀句话描述这个变量表⽰什么)*/</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter ⽅法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/*** @return ${bare_field_name}*/</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/*** <p>Title:${file_name} </p>* <p>Description: 构造函数</p>* ${tags}*/</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java ⽂件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/*** @Title: ${file_name}* @Package ${package_name}* @Description: ${todo}(⽤⼀句话描述该⽂件做什么)* @author DAIGUANGJIU* @date ${date} ${time}* @version V1.0*/</template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter ⽅法的注释" enabled="true"* @param ${param} 要设置的 ${bare_field_name}*/</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/*** @author ${user}** ${tags}*/</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表⽅法的注释"enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/*** ${tags}* ${see_to_target}*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖⽅法的注释"enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (⾮ Javadoc)* <p>Title: ${enclosing_method}</p>* <p>Description: </p>* ${tags}* ${see_to_overridden}*/</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="⾮覆盖⽅法的注释"enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/*** ${tags}*/</template></templa例⼦2:view plaincopy to clipboardprint?<?xml version="1.0" encoding="UTF-8"?><templates><templateautoinsert="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}.*/</template><templateautoinsert="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><templateautoinsert="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@* @version: ${date} ${time}*/</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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="false"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><templateautoinsert="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@* @version: ${date} ${time}*/</template></templates>。

java自定义注解例子

java自定义注解例子

在Java中,自定义注解是一个非常有用的工具,可以让你添加元数据到代码中,并且在运行时或编译时进行一些额外的处理。

以下是一个自定义注解的例子:首先,你需要定义一个接口,这个接口定义了你的注解将要具有的属性。

在这个例子中,我们将创建一个名为"Age"的注解,它有一个整数字段:```javaimport ng.annotation.*;@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.METHOD)public @interface Age {int value() default 0;}```在这个例子中,`@Retention(RetentionPolicy.RUNTIME)` 表示这个注解的生命周期是运行时,`@Target(ElementType.METHOD)` 表示这个注解可以用在方法上。

然后,你可以在你的代码中使用这个注解:```javapublic class Person {@Age(25)public void setName(String name) {//...}}```在这里,我们在`setName`方法上使用了`@Age`注解,并设置了它的值为25。

最后,你可以通过反射来读取和使用这个注解:```javapublic static void main(String[] args) {Person person = new Person();Method[] methods = person.getClass().getDeclaredMethods();for (Method method : methods) {if (method.isAnnotationPresent(Age.class)) {Age age = method.getAnnotation(Age.class);System.out.println("Method: " + method.getName() + ", Age: " + age.value());}}}```在这个例子中,我们创建了一个`Person`对象,并通过反射获取了它的所有方法。

idea新建类和方法的注释

idea新建类和方法的注释

idea新建类和⽅法的注释idea新建类和⽅法的注释⼀、创建类模板1、File-->settings-->Editor-->File and Code Templates-->Files,在这个李我主要是针对class⽂件加模板1. ${NAME}:设置类名。

2. TODO:添加描述。

3. ${USER}、${DATE}、${TIME}:设置创建类的⽤户、创建的⽇期和时间,这些事IDEA内置的⽅法,还有其他的内置⽅法,如需要可以⾃⾏查询。

4. 1.0:设置版本号,可以根据⾃⼰的实际情况填写版本号,⼀般新创建的类都是1.0版本。

注释模板/*** @ClassName ${NAME}* @Description TODO* @Author ${USER}* @Date ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}* @Version 1.0**/⼆、设置⽅法注释模板1. File-->Settings-->Editor-->Live Templates2. 新建组:命名为userDefine3. 新建模板,新建模板:命名为* ,因为IDEA⽣成注释的默认⽅式是:/*+模板名+快捷键(⽐如若设置模板名为add快捷键⽤Tab,则⽣成⽅式为/*add+Tab),如果不采⽤这样的⽣成⽅式IDEA中没有内容的⽅法将不可⽤,例如获取⽅法参数的methodParameters()、获取⽅法返回值的methodReturnType()4. 设置快捷键5. 设置模板:模板内容如下注意第⼀⾏,只有⼀个* ⽽不是 /*在设置参数名时必须⽤${参数名}$的⽅式,否则第五步中读取不到你设置的参数名** @Description:* @Author: ming* @Date: $date$ $time$$param$$return$**/6.设置参数的获取⽅式注意选择每个参数对应的获取⽅法(在下拉选择框中选择即可),⽹上有很多教程说获取param时使⽤脚本的⽅式,我试过使⽤脚本的⽅式不仅⿇烦⽽且只能在⽅法内部使⽤注释时才能获取到参数params变量:内容⼀定要放在Default value中内容为:groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param ' + params[i] + ': '}else{result+='\\n' + ' * @param ' + p return变量也⼀定要放在Default value中内容为groovyScript("def returnType = \"${_1}\"; def result = '* @return: ' + returnType; return result;", methodReturnType());7. 设置模板的应⽤场景如果没有设置应⽤场景则会有警告,我这⾥已经应⽤了,所以提⽰是change;点击模板页⾯最下⽅的警告,来设置将模板应⽤于那些场景,⼀般选择EveryWhere-->Java即可(如果曾经修改过,则显⽰为change⽽不是define)8、新建类查看效果。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments 节点就是所有需设置注释的元素啦。

现就每一个元素逐一介绍:文件(Files)注释标签:/*** @Project: ${project_name}* @Title: ${file_name}* @Package ${package_name}* @Description: ${todo}* @author shenyanghong ahong2011@* @date ${date} ${time}* @Copyright: ${year} Inc. All rights reserved.* @version V1.0*/类(Types)注释标签(类的注释):/*** @ClassName ${type_name}* @Description ${todo}* @author shenyanghong ahong2011@* @date ${date}* ${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}*/简单模板例1:<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true"context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/*** @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)*/</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/*** @return ${bare_field_name}*/</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/** * <p>Title:${file_name} </p>* <p>Description: 构造函数</p>* ${tags}*/</template><template autoinsert="true" context="filecomment_context" deleted="false" description="Java 文件的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/*** @Title: ${file_name}* @Package ${package_name}* @Description: ${todo}(用一句话描述该文件做什么)* @author jeffshaw email:jeff_chon@* @date ${date} ${time}* @version V1.0*/</template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/*** @param ${param} 要设置的 ${bare_field_name}*/</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/*** @author ${user}** ${tags}*/</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/*** ${tags}* ${see_to_target}*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非Javadoc)* <p>Title: ${enclosing_method}</p>* <p>Description: </p>* ${tags}* ${see_to_overridden}*/</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/*** ${tags}*/</template></templa<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true"context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/*** @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)*/</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/*** @return ${bare_field_name}*/</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/** * <p>Title:${file_name} </p>* <p>Description: 构造函数</p>* ${tags}*/</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/*** @Title: ${file_name}* @Package ${package_name}* @Description: ${todo}(用一句话描述该文件做什么)* @author jeffshaw email:jeff_chon@* @date ${date} ${time}* @version V1.0*/</template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/*** @param ${param} 要设置的 ${bare_field_name}*/</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/*** @author ${user}** ${tags}*/</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/*** ${tags}* ${see_to_target}*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非Javadoc)* <p>Title: ${enclosing_method}</p>* <p>Description: </p>* ${tags}* ${see_to_overridden}*/</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/*** ${tags}*/</template></templa简单模板2:<?xml version="1.0" encoding="UTF-8"?><templates><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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: jeffwhaw email:jeff_chon@* @version: ${date} ${time}*/</template><templateautoinsert="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>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><templateautoinsert="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><templateautoinsert="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}*/<templateautoinsert="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><templateautoinsert="false"context="typecomment_context"deleted="false"description="Comment for created types"enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.typecomment"name="typecomment">/*** 此类描述的是:* @author: jeffshaw email:jeff_chon@* @version: ${date} ${time}*/</template></templates><?xml version="1.0" encoding="UTF-8"?><templates><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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: jeffshaw email:jeff_chon@* @version: ${date} ${time}*/</template><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="false"context="typecomment_context"deleted="false"description="Comment for created types"enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/*** 此类描述的是:* @author: jeffshaw email:jeff_chon@* @version: ${date} ${time}*/</template></templates>。

相关文档
最新文档