java注释模板xml_Java注释模板设置详解
设置注释模板的⼊⼝: 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}(⽤⼀句话描述这个变量表⽰什么)
*/
构造函数标签:
/**
*
Title:
*
Description:
* ${tags}
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这⾥⽤⼀句话描述这个⽅法的作⽤) * @param ${tags} 设定⽂件
* @return ${return_type} 返回类型
* @throws
*/
覆盖⽅法(Overriding Methods)标签:
/* (⾮ Javadoc)
*
Title: ${enclosing_method}
*
Description:
* ${tags}
* ${e_to_overridden}
*/
代表⽅法(Delegate Methods)标签:
/**
* ${tags}
* ${e_to_target}
*/
getter⽅法标签:
/**
* @return ${bare_field_name}
*/
tter⽅法标签:
/**
* @param ${param} 要设置的 ${bare_field_name}
*/
简单模板例⼦:
<?xml version="1.0" encoding="UTF-8"?>/**
金牛座圣斗士发出商品会计分录* @Fields ${field} : ${todo}(⽤⼀句话描述这个变量表⽰什么)
* @return ${bare_field_name}
*/
/**
*
Title:${file_name}
*
Description: 构造函数
* ${tags}
*/
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(⽤⼀句话描述该⽂件做什么) * @author DAIGUANGJIU
* @date ${date} ${time}
* @version V1.0
*/
/**
* @param ${param} 要设置的 ${bare_field_name} *//**
* @author ${ur}
*
* ${tags}
*//**
* ${tags}
* ${e_to_target}
*//** (⾮ Javadoc)
*
Title: ${enclosing_method}
*
Description:
* ${tags}
* ${tags}
*/
<?xml version="1.0" encoding="UTF-8"?>/**
* @Fields ${field} : ${todo}(⽤⼀句话描述这个变量表⽰什么) */
/**
* @return ${bare_field_name}
*/
/
**
*
Title:${file_name}
*
Description: 构造函数
* ${tags}
*/
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(⽤⼀句话描述该⽂件做什么)
* @author DAIGUANGJIU
* @date ${date} ${time}
* @version V1.0
*/
/**
* @param ${param} 要设置的 ${bare_field_name}
*//**
微波爆米花
清除垃圾软件* @author ${ur}
*
* ${tags}
*//**
* ${tags}
* ${e_to_target}
Title: ${enclosing_method}
*
Description:
* ${tags}
* ${e_to_overridden}
*//**
* ${tags}
*/
例⼦2:
autoinrt="fal"
context="constructorcomment_context"
deleted="fal"
description="Comment for created constructors"
enabled="true"
id="lip.structorcomment" name="constructorcomment">
/**
* 创建⼀个新的实例 ${enclosing_type}.
*
* ${tags}
*/
autoinrt="true"
context="ttercomment_context"
deleted="fal"
description="Comment for tter method"
enabled="true"
id="lip.mment"
name="ttercomment">
/**
* @param ${param} the ${bare_field_name} to t
*/
autoinrt="fal"