myeclipse 添加注释的 模板
1、打开myeclipse工具。
2、window-Preferences-java-Code Style-Code Templates-import。
3、下面就是xml的文件内容信息。
<?xml version="1.0" encoding="UTF-8"?>
<templates>
<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="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>
<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">
/**
* 此方法描述的是：
* @author: [email protected]
* @version: ${date} ${time}
*/
</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="filecomment_context"
deleted="false"
description="Comment for created Java files"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
name="filecomment">
/**
* 文件名：${file_name}
*
* 版本信息：
* 日期：${date}
* Copyright 公司 Corporation ${year}
* 版权所有
*
*/
</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">
/**
* ${bare_field_name}
*
* @return the ${bare_field_name}
* @since CodingExample Ver(编码范例查看) 1.0
*/
</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">
/* (non-Javadoc)
* ${see_to_overridden}
*/
</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">
/**
* ${field}:${todo}（用一句话描述这个变量表示什么）
*
* @since Ver 1.1
*/
</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">
/**
* 此类描述的是：
* @author: [email protected]
* @version: ${date} ${time}
*/
</template>
</templates>
下面是注释规范大家可以根据自己公司的规范写，举例如下：
文件(Files)注释标签：
/** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} * @author * @date ${date} ${time} * @version V1.0 */
类型(Types)注释标签（类的注释）：
/** * 类功能说明: * 类修改者: 修改日期: * 修改说明: * <p>Title: ${file_name}</p> * <p>Description:XXX科技开发平台</p> * <p>Copyright: Copyright (c) 2006</p> * <p>Company:XXX公司</p> * @author ${user} * @date ${date} ${time} * @version V1.0 */
字段(Fields)
注释标签： /** @Fields ${field} : ${todo} */
构造函数标签：
/** <p>Title: </p> * <p>Description: </p> * ${tags} */
方法(Constructor & Methods)
标签: /** *函数功能说明: *${user} *${date} *修改者名字: *修改日期: *修改内容 *${tags} *@return ${return_type} *@throws */
getter 方法标签：
/** *@return ${bare_field_name} */
setter
方法标签：
/** *@param ${param} * *${bare_field_name} */