Eclipse 中设置作者日期等Java注释模板
原创约 1233 字大约 4 分钟...
Eclipse 中设置作者日期等Java注释模板
注意
本博文仅供学术研究和交流参考，严禁将其用于商业用途。如因违规使用产生的任何法律问题，使用者需自行负责。
- 设置注释模板的步骤：点击菜单栏上的Window -->Preferences-->Java-->Code Style -->Code Templates
- 常用的注解介绍：
@author 作者名
@date 日期
@version 版本标识
@parameter 参数及其意义
@return 返回值
@throws 异常类及抛出条件
@deprecated 引起不推荐使用的警告
@override 重写
- Comment详细设置 ① Comments下的Files设置
/**
* <p>Title: ${file_name}</p>
* <p>Description: </p>
* <p>Copyright: Copyright (c) 2017</p>
* <p>Company: www.baidudu.com</p>
* @author xianxian
* @date ${date}
* @version 1.0
*/
- ②Types：对类进行注释
/**
* <p>Title: ${type_name}</p>
* <p>Description: </p>
* @author xianxian
* @date ${date}
*/
- ③Fields:对字段进行注释
/**
* ${field}
*/
- ④Constructors:对构造方法进行注释
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
- ⑤Methods：对方法进行注释
/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
*/
- ⑥Overriding Methods：对重写方法进行注释
/* (non-Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
- ⑦ Delegate methods：对代表方法进行注释
/**
* ${tags}
* ${see_to_target}
*/
- ⑧Getters：对get方法进行注释
/**
* @return the ${bare_field_name}
*/
- ⑨Setters：对set方法进行注释
/**
* @param ${param} the ${bare_field_name} to set
*/
- 最后：
- 注释模板的导出（导入不作介绍）
- codetemplates.xml
<?xml version="1.0" encoding="UTF-8" standalone="no"?><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">/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/</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}
*/</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">/**
* <p>Title: ${file_name}</p>
* <p>Description: </p>
* <p>Copyright: Copyright (c) 2017</p>
* <p>Company: www.baidudu.com</p>
* @author xianxian
* @date ${date}
* @version 1.0
*/ </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)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/</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">/**
* @return the ${bare_field_name}
*/</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}
*/ </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">/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${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="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**
* <p>Title: ${type_name}</p>
* <p>Description: </p>
* @author xianxian
* @date ${date}
*/ </template></templates>
- Java注释模板的使用
- codetemplates2.xml
<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><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">/**<p>Title: ${enclosing_method}</p>
* <p>
* Description:
* </p>
* <p>Copyright: Copyright (c) 2017</p>
* <p>Company: www.baidudu.com</p>
* ${tags}
* @author xianxian
* @date ${date}
* @version 1.0
*/ </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">/**
* @return the ${bare_field_name}
*/</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}
*/ </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)
* <p>Title: ${enclosing_method}</p>
* <p>
* Description:
* </p>
* <p>Copyright: Copyright (c) 2017</p>
* <p>Company: www.baidudu.com</p>
* ${tags}
* ${see_to_overridden}
* @author xianxian
* @date ${date}
* @version 1.0
*/</template><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} the ${bare_field_name} to set
*/</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">/**<p>Title: ${type_name}</p>
* <p>
* Description:
* </p>
* @author xianxian
* @date ${date}
*/ </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">/**<p>Title: ${file_name}</p>
* <p>
* Description:
* </p>
* <p>Copyright: Copyright (c) 2017</p>
* <p>Company: www.baidudu.com</p>
* @author xianxian
* @date ${date}
* @version 1.0
*/ </template><template autoinsert="false" context="modulecomment_context" deleted="false" description="Comment for modules" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.modulecomment" name="modulecomment">/**
* @author ${user}
*
* ${tags}
*/</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}
*/</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">/**<p>Title: </p>
* <p>
* Description:
* </p>
* ${tags}
*/</template></templates>
- 我常用的是**直接输入/***而后按下确定键后就可以自动生成
参考链接：
分割线
相关信息
以上就是我关于 Eclipse 中设置作者日期等Java注释模板 知识点的整理与总结的全部内容，希望对你有帮助。。。。。。。
Powered by Waline v2.15.4