注釋模板

設(shè)置注釋模板的入口： Window->Preference->Java->Code Style->Code Template 然后展開Comments節(jié)點(diǎn)就是所有需設(shè)置注釋的元素啦≡持浚現(xiàn)就每一個(gè)元素逐一介紹：

文件(Files)注釋標(biāo)簽：

/**

  • @Title: ${file_name}
  • @Package ${package_name}
  • @Description: ${todo}
  • @author ${USER}
  • @date ${DATE} ${TIME}
  • @version V1.0
    */

類型(Types)注釋標(biāo)簽（類的注釋）：

/**

  • @ClassName: ${type_name}
  • @Description: ${todo}(這里用一句話描述這個(gè)類的作用)
  • @author A18ccms a18ccms_gmail_com
  • @date ${date} ${time}
  • ${tags}
    */

字段(Fields)注釋標(biāo)簽：

/**

  • @Fields ${field} : ${todo}(用一句話描述這個(gè)變量表示什么)
    */
    構(gòu)造函數(shù)標(biāo)簽：

/**

  • <p>Title: </p>
  • <p>Description: </p>
  • ${tags}
    */

方法(Constructor & Methods)標(biāo)簽：

/**

  • @Title: ${enclosing_method}
  • @Description: ${todo}(這里用一句話描述這個(gè)方法的作用)
  • @param ${tags} 設(shè)定文件
  • @return ${return_type} 返回類型
  • @throws
    */

覆蓋方法(Overriding Methods)標(biāo)簽：

/* (非 Javadoc)

  • <p>Title: ${enclosing_method}</p>
  • <p>Description: </p>
  • ${tags}
  • ${see_to_overridden}
    */

代表方法(Delegate Methods)標(biāo)簽：

/**

  • ${tags}
  • ${see_to_target}
    */
    getter方法標(biāo)簽：

/**

  • @return ${bare_field_name}
    */

setter方法標(biāo)簽：

/**

  • @param ${param} 要設(shè)置的 ${bare_field_name}
    */

簡(jiǎn)單模板例子：
<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**

  • @Fields ${field} : ${todo}(用一句話描述這個(gè)變量表示什么)
    /
    </template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/    *
  • @return ${bare_field_name}
    /
    </template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="創(chuàng)建的構(gòu)造函數(shù)的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/    *
  • <p>Title:${file_name} </p>
  • <p>Description: 構(gòu)造函數(shù)</p>
  • ${tags}
    /
    </template><template autoinsert="true" context="filecomment_context" deleted="false" description="已創(chuàng)建的 Java 文件的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/    *
  • @Title: ${file_name}
  • @Package ${package_name}
  • @Description: ${todo}(用一句話描述該文件做什么)
  • @author DAIGUANGJIU
  • @date ${date} ${time}
  • @version V1.0
    /
    </template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/    *
  • @param ${param} 要設(shè)置的 ${bare_field_name}
    /</template><template autoinsert="true" context="typecomment_context" deleted="false" description="創(chuàng)建的類型的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/*
  • @author ${user}
  • ${tags}
    /</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/*
  • ${tags}
  • ${see_to_target}
    /</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆蓋方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/* (非 Javadoc)
  • <p>Title: ${enclosing_method}</p>
  • <p>Description: </p>
  • ${tags}
  • ${see_to_overridden}
    /</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆蓋方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/*
  • ${tags}
    /</template></templa
    <?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/    *
  • @Fields ${field} : ${todo}(用一句話描述這個(gè)變量表示什么)
    /
    </template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/    *
  • @return ${bare_field_name}
    /
    </template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="創(chuàng)建的構(gòu)造函數(shù)的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/    *
  • <p>Title:${file_name} </p>
  • <p>Description: 構(gòu)造函數(shù)</p>
  • ${tags}
    /
    </template><template autoinsert="true" context="filecomment_context" deleted="false" description="已創(chuàng)建的 Java 文件的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/    *
  • @Title: ${file_name}
  • @Package ${package_name}
  • @Description: ${todo}(用一句話描述該文件做什么)
  • @author DAIGUANGJIU
  • @date ${date} ${time}
  • @version V1.0
    /
    </template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/    *
  • @param ${param} 要設(shè)置的 ${bare_field_name}
    /</template><template autoinsert="true" context="typecomment_context" deleted="false" description="創(chuàng)建的類型的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/*
  • @author ${user}
  • ${tags}
    /</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/*
  • ${tags}
  • ${see_to_target}
    /</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆蓋方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/* (非 Javadoc)
  • <p>Title: ${enclosing_method}</p>
  • <p>Description: </p>
  • ${tags}
  • ${see_to_overridden}
    /</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆蓋方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/*
  • ${tags}
    */</template></templa

例子2：
<?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">
/**
* 創(chuàng)建一個(gè)新的實(shí)例 ${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: wangxiongdx@163.com
* @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}
* 版權(quán)所有
*
/
</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}（用一句話描述這個(gè)變量表示什么）
*
* @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: wangxiongdx@163.com
* @version: ${date} ${time}
/
</template>
</templates>
<?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">
/*
* 創(chuàng)建一個(gè)新的實(shí)例 ${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: wangxiongdx@163.com
* @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}
* 版權(quán)所有
*
/
</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}（用一句話描述這個(gè)變量表示什么） 
 * 
 * @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: wangxiongdx@163.com 
 * @version: ${date} ${time} 
 */ 
</template>

</templates>

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 人面猴
    序言：七十年代末俏让，一起剝皮案震驚了整個(gè)濱河市，隨后出現(xiàn)的幾起案子枕稀，更是在濱河造成了極大的恐慌瓮栗，老刑警劉巖粪牲，帶你破解...
    沈念sama閱讀 211,884評(píng)論 6贊 492
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件飒房，死亡現(xiàn)場(chǎng)離奇詭異膀藐，居然都是意外死亡，警方通過查閱死者的電腦和手機(jī)于颖，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,347評(píng)論 3贊 385
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進(jìn)店門呆贿，熙熙樓的掌柜王于貴愁眉苦臉地迎上來，“玉大人，你說我怎么就攤上這事做入∶拔” “怎么了？”我有些...
    開封第一講書人閱讀 157,435評(píng)論 0贊 348
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵竟块，是天一觀的道長壶运。 經(jīng)常有香客問我，道長浪秘，這世上最難降的妖魔是什么蒋情？ 我笑而不...
    開封第一講書人閱讀 56,509評(píng)論 1贊 284
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任，我火速辦了婚禮耸携，結(jié)果婚禮上棵癣，老公的妹妹穿的比我還像新娘。我一直安慰自己夺衍，他們只是感情好狈谊，可當(dāng)我...
    茶點(diǎn)故事閱讀 65,611評(píng)論 6贊 386
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布。 她就那樣靜靜地躺著沟沙，像睡著了一般河劝。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上矛紫，一...
    開封第一講書人閱讀 49,837評(píng)論 1贊 290
  • 城市分裂傳說
    那天赎瞎，我揣著相機(jī)與錄音，去河邊找鬼颊咬。 笑死务甥，一個(gè)胖子當(dāng)著我的面吹牛，可吹牛的內(nèi)容都是我干的贪染。 我是一名探鬼主播缓呛，決...
    沈念sama閱讀 38,987評(píng)論 3贊 408
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼，長吁一口氣：“原來是場(chǎng)噩夢(mèng)啊……” “哼杭隙！你這毒婦竟也來了哟绊？” 一聲冷哼從身側(cè)響起，我...
    開封第一講書人閱讀 37,730評(píng)論 0贊 267
  • 萬榮殺人案實(shí)錄
    序言：老撾萬榮一對(duì)情侶失蹤痰憎，失蹤者是張志新（化名）和其女友劉穎票髓，沒想到半個(gè)月后，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體铣耘，經(jīng)...
    沈念sama閱讀 44,194評(píng)論 1贊 303
  • ?護(hù)林員之死
    正文 獨(dú)居荒郊野嶺守林人離奇死亡洽沟，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,525評(píng)論 2贊 327
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年，在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了蜗细。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片裆操。...
    茶點(diǎn)故事閱讀 38,664評(píng)論 1贊 340
  • 活死人
    序言：一個(gè)原本活蹦亂跳的男人離奇死亡怒详，死狀恐怖，靈堂內(nèi)的尸體忽然破棺而出踪区，到底是詐尸還是另有隱情昆烁，我是刑警寧澤，帶...
    沈念sama閱讀 34,334評(píng)論 4贊 330
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布缎岗，位于F島的核電站静尼，受9級(jí)特大地震影響，放射性物質(zhì)發(fā)生泄漏传泊。R本人自食惡果不足惜鼠渺，卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,944評(píng)論 3贊 313
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望眷细。 院中可真熱鬧拦盹，春花似錦、人聲如沸薪鹦。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,764評(píng)論 0贊 21
  • 一樁弒父案，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽池磁。三九已至，卻和暖如春楷兽，著一層夾襖步出監(jiān)牢的瞬間地熄，已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,997評(píng)論 1贊 266
  • 情欲美人皮
    我被黑心中介騙來泰國打工芯杀， 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留端考，地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,389評(píng)論 2贊 360
  • 代替公主和親
    正文 我出身青樓揭厚，卻偏偏與公主長得像却特，于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子筛圆，可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,554評(píng)論 2贊 349

推薦閱讀更多精彩內(nèi)容