Eclipse Java注释模板设置详解

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Eclipse 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}
    */

方法(Constructor & Methods)标签:

/**

  • @Title: ${enclosing_method}
  • @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}
    */

简单模板例子:

例子2:



<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> 


















以上是关于Eclipse Java注释模板设置详解的主要内容,如果未能解决你的问题,请参考以下文章

Eclipse Java注释模板设置详解以及版权声明

Eclipse Java注释模板设置详解

Eclipse Java注释模板设置详解

Eclipse Java注释模板设置详解

Eclipse Java注释模板设置详解

Eclipse Java注释模板设置详解