作为一个程序员,所写代码的可读性是很重要的!而可读性好的代码不但要有规范的格式,而且还要有适当的注释。每个类、方法、属性或者重要的代码段都应当写上相关的注释,以便下次或者他人阅读代码。在Eclipse中就有自动为类、方法、属性生成注释的功能。至于注释要显示什么,怎样显示可以根据自己的需要进行调整,也可以直接导入模版,这样比较省事。在这里主要说一下导入模版的方法。
首先,将下面的内容复制下来,生成一个XML文件。
<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="false" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">
/**
* @param ${param} : set the property ${bare_field_name}.
* @author ${user}
* @update ${date} ${time}
*/
</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}
* @description
* @version 1.0
* @author ${user}
* @update ${date} ${time}
*/
</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">
/**
* @author ${user}
* @update ${date} ${time}
* @return ${bare_field_name} : return the property ${bare_field_name}.
*/
</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">
/**
* @description
* @version 1.0
* @author ${user}
* @update ${date} ${time}
*/
</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">
/**
* Constructor Method
* @author ${user}
* @update ${date} ${time}
* ${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}
* @author ${user}
* @update ${date} ${time}
*/
</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">
/**
* @title ${file_name}
* @package ${package_name}
* @description
* @author ${user}
* @update ${date} ${time}
* @version V1.0
*/
</template><template autoinsert="false" 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}
* @author ${user}
* @update ${date} ${time}
*/
</template><template autoinsert="false" 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}
* @author ${user}
* @update ${date} ${time}
*/
</template></templates>
然后,在window->preferences->java->code style->code templates下找到注释模版
最后,点击import导入刚才生成的XML文件,再点击Apply。