Eclipse注释模板设置详解

设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。本文现就每一个元素逐一给大家介绍一下。

文件(Files)注释标签:

[html] view plain copy

/**  

* @Title: ${file_name}  

* @Package ${package_name}  

* @Description: ${todo}(用一句话描述该文件做什么)  

* @author ${user}  

* @date ${date}  

* @version V1.0  

*/  

类型(Types)注释标签(类的注释):

[html] view plain copy

/**  

* @ClassName: ${type_name}  

* @Description: ${todo}(这里用一句话描述这个类的作用)  

* @author ${user}  

* @date ${date}  

*  

* ${tags}  

*/  

字段(Fields)注释标签:

[html] view plain copy

/**  

* @Fields field:field:{todo}(用一句话描述这个变量表示什么)  

*/  


构造函数(Constructor)标签:

[html] view plain copy

/**  

* 创建一个新的实例 ${enclosing_type}.  

*  

* ${tags}  

*/  

方法(Methods)标签:

[html] view plain copy

/**  

* @Title: ${enclosing_method}  

* @Description: ${todo}(这里用一句话描述这个方法的作用)  

* @param ${tags}    参数  

* @return ${return_type}    返回类型  

* @throws  

*/  

覆盖方法(Overriding Methods)标签:

[html] view plain copy

/* (非 Javadoc)  

*

Title: ${enclosing_method}


*

Description: 


* ${tags}  

* ${see_to_overridden}  

*/  

代理方法(Delegate Methods)标签:

[html] view plain copy

/**  

* ${tags}  

* ${see_to_target}  

*/  

getter方法标签:

[html] view plain copy

/**  

* @return ${bare_field_name}  

*/  


setter方法标签:

[html] view plain copy

/**  

* @param paramtheparamthe{bare_field_name} to set  

*/  

要实现上面的注释模板,这需要将下面的配置文件导入就可以了:

[html] view plain copy



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

    /**    

    * @Title: ${file_name}  

    * @Package ${package_name}  

    * @Description: ${todo}(用一句话描述该文件做什么)  

    * @author ${user}  

    * @date ${date}  

    * @version V1.0    

    */  


autoinsert="false"  

context="typecomment_context"  

deleted="false"  

description="Comment for created types"  

enabled="true"  

id="org.eclipse.jdt.ui.text.codetemplates.typecomment"  

name="typecomment">  

    /**  

    * @ClassName: ${type_name}  

    * @Description: ${todo}(这里用一句话描述这个类的作用)  

    * @author ${user}  

    * @date ${date}  

    *  

    * ${tags}  

    */  


autoinsert="false"  

context="fieldcomment_context"  

deleted="false"  

description="Comment for fields"  

enabled="true"  

id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"  

name="fieldcomment">  

    /**  

    * @Fields field:field:{todo}(用一句话描述这个变量表示什么)  

    */  


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}  

     */  


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

    /**  

    * @Title: ${enclosing_method}  

    * @Description: ${todo}(这里用一句话描述这个方法的作用)  

    * @param ${tags}    参数  

    * @return ${return_type}    返回类型  

    * @throws  

    */  


autoinsert="true"  

context="overridecomment_context"  

deleted="false"  

description="Comment for overriding methods"  

enabled="true"  

id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"  

name="overridecomment">  

    /* (非 Javadoc)  

*

Title: ${enclosing_method}


*

Description: 


    * ${tags}  

    * ${see_to_overridden}  

    */  


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}  

     */  


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 ${bare_field_name}  

    */  


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 paramtheparamthe{bare_field_name} to set  

     */  

/* 确定一个系统的学习Java的计划,如果想自学,那么你就找一套非常系统的学习视频。如果你自己找不到系统的学习视频。可以加下小编的Java学习群:557865078,编号(烟火)不管你是小白还是大牛,小编我都欢迎,不定期分享干货,包括小编自己整理的一份2018最新的Java学习资料和0基础入门教程,欢迎初学和进阶中的小伙伴。*/

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,658评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,482评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,213评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,395评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,487评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,523评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,525评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,300评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,753评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,048评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,223评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,905评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,541评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,168评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,417评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,094评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,088评论 2 352

推荐阅读更多精彩内容

  • 设置注释模板的入口: Window->Preference->Java->Code Style->Code Tem...
    柒黍阅读 647评论 0 0
  • 例如: /** * @param * @return */ 快捷键为:ALT + SHIFT +J 想更换为其他的...
    宝贝双双阅读 2,334评论 0 0
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,646评论 18 139
  • =========================================================...
    lavor阅读 3,487评论 0 5
  • 各种的担心害怕阻止着前进的步伐,害怕一脸的幼稚,智障的套路,浪费无辜的时间而得不到该有的享受与快乐。却又好奇并...
    米小勒_28e5阅读 211评论 0 0