在我们平时使用Eclipse开发的时候,会特别强调注释的重要性,那么怎么才能让你的注释看起来专业跟高大上呢?
设置注释模板的入口:
Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。
这里可以看到所有的需要注释的类型,上面是注释类型,下面是注释内容。这个时候,我们不用着急着去改,直接点击修改是没有用的,在右侧选择Comments,将其中的Files项,然后选右边的”Edit”,进入编辑模式:
进入编辑模式后就可以自定义注释了。另外可以插入一些变量,如年、日期等等。
最后,确保 Code -> New Java files 中有:”${filecomment}”
当然,通过“导出”和“导入”功能,你可以把自己的模板导出来在其他机器上使用。
现就每一个元素逐一介绍:
文件(Files)注释标签:
/**
* @Title:
filename∗@Package
{package_name}
* @Description:
todo(用一句话描述该文件做什么)∗@authorA18ccmsA18ccmsgmailcom∗@date
{date} ${time}
* @version V1.0
*/
类型(Types)注释标签(类的注释):
/**
* @ClassName:
typename∗@Description:
{todo}(这里用一句话描述这个类的作用)
* @author A18ccms a18ccms_gmail_com
* @date
date
{time}
*
* ${tags}
*/
字段(Fields)注释标签:
/**
* @Fields
field:
{todo}(用一句话描述这个变量表示什么)
*/
构造函数标签:
/**
*
Title:
*
Description:
* ${tags}
*/
方法(Constructor & Methods)标签:
/**
* @Title:
enclosingmethod∗@Description:
{todo}(这里用一句话描述这个方法的作用)
* @param
tags设定文件∗@return
{return_type} 返回类型
* @throws
*/
覆盖方法(Overriding Methods)标签:
/* (非 Javadoc)
*
Title: ${enclosing_method}
*
Description:
* tags∗ {see_to_overridden}
*/
代表方法(Delegate Methods)标签:
/**
*
tags∗
{see_to_target}
*/
getter方法标签:
/**
* @return ${bare_field_name}
*/
setter方法标签:
/**
* @param
param要设置的
{bare_field_name}
*/
以上是文件注释,类中的方法自动添加注释类似,对应于Files下面的Types。
Eclipse快捷键:选中你的方法后alt+shift+J