Android修炼之道—Template Code 模板

Eclipse的Template Code

设置注释模板的入口： 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} 

*/

setter方法标签：
/** 

* @param ${param} 要设置的 ${bare_field_name} 

*/

在Java文件中设置作者、日期等说明：

windows(窗口)-Preferences(首选项)-Java-Code Style(代码样式)-Code Templates(代码模版)-右侧Comments(注释)-选择Types(类型)-点击edit(编辑)-输入如下信息
/**

* @包名   ${package_name}

* @文件名 ${file_name}

* @作者   NoureWang

* @创建日期 ${date}

* @版本 V 1.0

*/

点击OK(确定)-选中左侧的代码样式-选择右侧复选框(Automatically add Comments for new
Methods and types)(自动为新方法和类型添加注释)-点击Apply(应用)-点击OK(确定)