Eclipse配置註釋模板詳細介紹

<引言>

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>

需要修改那個地方只需要在那個樣式處直接修改即可。

導入配置文件後，勾選如下選項（允許創建類的時候自動添加註釋，也可以不選）如下圖，然後應用

當寫完一個方法或者變數的時候 在前面打出    /**  三個符號再按回車，就能自動生成註釋了，效果如下下圖