1. 程式人生 > >JAVA程式碼註釋模板

JAVA程式碼註釋模板

首先,先建一個空的XML檔案,然後將以下的程式碼複製進去!下面的註釋中包括了日常中使用頻繁的程式碼註釋模版!模板裡面的名字,版本等等資訊需要修改為自己的資訊!

<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" 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="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="true" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
 * ${tags}
 */</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">/**
 * Copyright (C) ${year} Asiainfo-Linkage
 *
 *
 * @className:${package_name}.${type_name}
 * @description:${todo}
 *
 * @version:v1.0.0
 * @author:yanshaobo
 *
 * Modification History:
 * Date         Author      Version     Description
 * -----------------------------------------------------------------
 * ${date}     yanshaobo       v1.0.0        create
 *
 *
 */</template><template autoinsert="true" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**
 * @author yanshaobo
 *
 * ${tags}
 */</template><template autoinsert="true" context="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
 *
 */</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">/**
 *
 * @Function: ${package_name}.${enclosing_type}.${enclosing_method}
 * @Description:
 *
 * ${tags}
 *
 * @version:v1.0
 * @author:yanshaobo
 * @date:${date} ${time}
 *
 * Modification History:
 * Date         Author      Version     Description
 * -----------------------------------------------------------------
 * ${date}    yanshaobo      v1.0.0         create
 */</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="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="newtype_context" deleted="false" description="Newly created files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.newtype" name="newtype">${filecomment}
${package_declaration}

${type_declaration}</template><template autoinsert="true" context="classbody_context" deleted="false" description="Code in new class type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.classbody" name="classbody">
</template><template autoinsert="false" context="interfacebody_context" deleted="false" description="Code in new interface type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.interfacebody" name="interfacebody"></template><template autoinsert="true" context="enumbody_context" deleted="false" description="Code in new enum type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.enumbody" name="enumbody">
</template><template autoinsert="true" context="annotationbody_context" deleted="false" description="Code in new annotation type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.annotationbody" name="annotationbody">
</template><template autoinsert="true" context="catchblock_context" deleted="false" description="Code in new catch blocks" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.catchblock" name="catchblock">// ${todo} Auto-generated catch block
${exception_var}.printStackTrace();</template><template autoinsert="true" context="methodbody_context" deleted="false" description="Code in created method stubs" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodbody" name="methodbody">// ${todo} Auto-generated method stub
${body_statement}</template><template autoinsert="true" context="constructorbody_context" deleted="false" description="Code in created constructor stubs" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorbody" name="constructorbody">${body_statement}
// ${todo} Auto-generated constructor stub</template><template autoinsert="true" context="getterbody_context" deleted="false" description="Code in created getters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.getterbody" name="getterbody">return ${field};</template><template autoinsert="true" context="setterbody_context" deleted="false" description="Code in created setters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.setterbody" name="setterbody">${field} = ${param};</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="Comment for getter function" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
 * @return the ${bare_field_name}
 */</template><template autoinsert="true" context="settercomment_context" deleted="false" description="Comment for setter function" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.settercomment" name="settercomment">/**
 * @param ${param} the ${bare_field_name} to set
 */</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
 * ${tags}
 */</template><template autoinsert="true" context="filecomment_context" deleted="false" description="Comment for created JavaScript files" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.filecomment" name="filecomment">/**
 *
 */</template><template autoinsert="true" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.typecomment" name="typecomment">/**
 * @author yanshaobo
 *
 * ${tags}
 */</template><template autoinsert="true" context="fieldcomment_context" deleted="false" description="Comment for vars" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
 *
 */</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="Comment for non-overriding function" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
 * ${tags}
 */</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="Comment for overriding functions" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.overridecomment" name="overridecomment">/* (non-JSDoc)
 * ${see_to_overridden}
 */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="Comment for delegate functions" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
 * ${tags}
 * ${see_to_target}
 */</template><template autoinsert="false" context="newtype_context" deleted="false" description="Newly created files" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.newtype" name="newtype">
${package_declaration}

${typecomment}
${type_declaration}</template><template autoinsert="true" context="classbody_context" deleted="false" description="Code in new class type bodies" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.classbody" name="classbody">
</template><template autoinsert="true" context="catchblock_context" deleted="false" description="Code in new catch blocks" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.catchblock" name="catchblock">// ${todo} Auto-generated catch block
${exception_var}.printStackTrace();</template><template autoinsert="true" context="methodbody_context" deleted="false" description="Code in created function stubs" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.methodbody" name="methodbody">// ${todo} Auto-generated function stub
${body_statement}</template><template autoinsert="true" context="constructorbody_context" deleted="false" description="Code in created constructor stubs" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.constructorbody" name="constructorbody">${body_statement}
// ${todo} Auto-generated constructor stub</template><template autoinsert="true" context="getterbody_context" deleted="false" description="Code in created getters" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.getterbody" name="getterbody">return ${field};</template><template autoinsert="true" context="setterbody_context" deleted="false" description="Code in created setters" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.setterbody" name="setterbody">${field} = ${param};</template></templates>

第2步:將其匯入到開發工具中,點選window->preference->java->CodeStyle->Code

                                                                                                 Templates->Comments->Import... 

OK~    快去試試吧。。

相關推薦

JAVA程式碼註釋模板

首先,先建一個空的XML檔案,然後將以下的程式碼複製進去!下面的註釋中包括了日常中使用頻繁的程式碼註釋模版!模板裡面的名字,版本等等資訊需要修改為自己的資訊! <?xml version="1.0" encoding="UTF-8"?><templa

MyEclipse設定Java程式碼註釋模板

定義自己喜歡的模板註釋 選中你要加註釋的方法或類,按 Alt + shift + J。   檔案 (Files)註釋標籤: /**    * @Title:

Idea-Java程式碼註釋規範

  IDEA自帶的註釋模板不是太好用,我本人到網上搜集了很多資料系統的整理了一下製作了一份比較完整的模板來分享給大家(如果嫌配置繁瑣,可以在本頁面最下方下載jar包,匯入idea,就可以了)。 一、首先我們來設定IDEA中類的模板:(IDEA中在建立類時會自動給添加註釋)

解決eclipse中java程式碼註釋變成亂碼的問題

Eclipse JAVA檔案註釋亂碼將別人的專案或JAVA檔案匯入到自己的Eclipse中時,常常會出現JAVA檔案的中文註釋變成亂碼的情況,主要原因就是別人的IDE編碼格式和自己的Eclipse編碼格式不同。 總結網上的建議和自己的體會,可以參考以下幾種解決方式: 1 改變整個檔案型別的編碼格式

Java程式碼註釋TODO FIXME XXX的意義

TODO: 說明: 如果程式碼中有該標識,說明在標識處有功能程式碼待編寫,待實現的功能在說明中會簡略說明。 表示需要實現,但目前還未實現的功能FIXME: 說明: 如果程式碼中有該標識,說明標識處程式

開發工具Eclipse-程式碼註釋模板

點選選單Window->Preferences彈出首選項設定視窗 展開左側Java->Code Style->Code Template選項列表,就可以看到所有需設定註釋的元素了 展開右側模板選項Comments,可以看到可以設定的註釋模板型別,包含Files,Types,F

Doxygen和VS助手配置程式碼註釋模板

Title:FileNote Shortcut:#filenote Description:檔案註釋/** * Copyright (c) $YEAR$, xx科技有限公司(http://blog.csdn.net/stelalala) * All rights res

eclipse/sts 程式碼註釋模板

<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="true" context="gettercomment_context

java程式碼註釋翻譯

import java.io.File; import java.io.IOException; import java.nio.file.FileVisitResult; import java.nio.file.Files; import java.nio.file.

4.Java程式碼註釋

轉載請保留原文連結: http://dashidan.com/article/java/basic/4.html 註釋也叫做註解.程式設計師寫出的程式碼一方面是讓計算機讀懂並執行,另一方面是

Eclipse中如何修改Java程式碼註釋的樣式和如何提取出註釋文件

摘要   習慣寫註釋不一定代表技術強,但是一個習慣寫註釋的程式設計師一定是個好程式設計師,至少寫的程式碼美觀,有益於後期維護。程式碼其實就是一種藝術品,如果有裝飾的註釋,那簡直就是美上加美,讓人賞析悅目。   我們都知道eclipse中可以快捷的為類,方法和

java程式碼註釋規範(二)

一、背景  1、當我們第一次接觸某段程式碼,但又被要求在極短的時間內有效地分析這段程式碼,我們需要什麼樣的註釋資訊?  2、怎麼樣避免我們的註釋冗長而且凌亂不堪呢?  3、在多人協同開發、維護的今天,我們需要怎麼樣的註釋來保證高質、高交的進行開發和維護工作呢?  二、意義

好玩的程式碼註釋模板

圖片轉字元的一個工具:戳這裡 /** * .,:,,,

{@link}與@see的簡單使用以及區別--如何寫好Java程式碼註釋

寫程式碼的時候,有時候,你需要寫一些註釋,把內容相互關聯起來,方便自己或別人看的時候,可以直接找到你關聯的程式碼類或者啥的。 這個時候,{@link}與@see,這2個javadoc註解就派上用場了,

Java規範化程式碼eclipse模板註釋

建議下載阿里規範化外掛 阿里的new java file的註釋模板(Type): /**  * @author ${user}  * @date ${currentDate:date('YYYY/MM/dd')}  */  

intellij idea 2017.3 新建JAVA類不自動新增模板程式碼註釋的解決方案

前陣子重灌了系統,不得不重新下一遍idea,但是這次新建了.java檔案之後居然是空白的檔案,之前會加一些自動生成的註釋什麼的。 網上找了一下無果只能自己搞了。 原因:程式碼模板中File Header內容莫名其妙清空了?? 解決方案:把本來應該在裡面的東西再手動寫回

程式碼註釋規範-IDEA 配置 Java 類方法註釋模板

1. 引言     團隊開發時,業務模組分配的越清晰,程式碼註釋管理越完善,越有利於後面維護,後面再管理也方便不少。另外也起著"文字磚"的作用,你懂的。註釋不需要很詳細,把程式碼塊方法塊功能簡述一下就行。不然三月後回頭看就要罵人了,罵完發現是自己寫的,嘖嘖嘖...     三種常用的 Ja

Eclipse Java註釋模板設置詳解

comment ons gmail const mail pack led dcom time 設置註釋模板的入口: Window->Preference->Java->Code Style->Code Template 然後展開Comments節點

Eclipse 程式碼添加註釋模板

        好的習慣養成好的程式碼書寫規範,同樣好得程式碼模組註釋也同樣重要,不管是對於開發人員還是後期運維人員,都能清楚得知道你得想法,對於程式碼模組註釋今天我就來介紹一下。 (第一種) 1.Window——>Preferences——&g

Idea使用筆記——自定註釋模板&自定義程式碼模板&自定義File and Code Templates

設定類註釋: File-->settings-->Editor-->File and Code Templates-->Files 類註釋模板: /** * @Classname ${NAME} * @Description TODO * @autho