Eclipse配置注释模板详细介绍

Posted 2021-01-23 henulhy

<引言>

Eclipse 中提供了一个非常人性化的功能，可以自动生成注释为我们程序员做项目时提供便利，并且注释内容还具有定制化

可以根据自己的喜好配置不同的样式。

<正文> 

首先我们需要找到，配置注释的地方。

Window  --> preferences --> java --> Code Style --> Code Templates.

 然后就能看到这个画面

红线部分可以看你现在的注释配置样式默认的样式都是很简单的/**/样式。

然后我们可以通过箭头处的  import 导入自己定义的或者其他人的模板样式的XML配置文件。

注意：XML文件的名字必须是： codetemplates.xml

模板的内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<templates>
<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 lhy
*@date ${date}
*${tags}
*/
</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">
/**
*@Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
</template>
<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="false"
context="methodcomment_context"
deleted="false"
description="Comment for non-overriding methods"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
name="methodcomment">
/**
*${tags}
*@return ${return_type}
*/
</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">
/*
*<p>Title: ${enclosing_method}</p>
*<p>Description: </p>
*${tags}
*${see_to_overridden}
*/
</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="gettercomment_context"
deleted="false"
description="Comment for getter method"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
name="gettercomment">
/**
*@return ${bare_field_name}
*/
</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>
</templates>

 

需要修改那个地方只需要在那个样式处直接修改即可。

导入配置文件后，勾选如下选项（允许创建类的时候自动添加注释，也可以不选）如下图，然后应用

当写完一个方法或者变量的时候 在前面打出    /**  三个符号再按回车，就能自动生成注释了，效果如下下图