myeclipse中類和方法添加註釋

來源:互聯網
上載者:User

給類加註釋:

方法一、Window --> Java --> Code Style --> Code Templates --> Comments --> types -->edit

/**

 *類描述:

 *@author: blank

 *@date: 日期:${date} 時間:${time}

 *${tags}

 *@version 1.0

 */

方法二、Window --> Java --> Code Style --> Code Templates --> Comments --> types -->import

<?xml version="1.0" encoding="UTF-8"?>

 <templates>

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

 /**

  * [Product]

  *     ${project_name}

  * [Copyright]

  *     Copyright ? ${year} ICSS All Rights Reserved.

  * [FileName]

  *     ${file_name}

  * [History]

  *     Version  Date      Author     Content

  *     -------- --------- ---------- ------------------------

  *     1.0.0    ${date}   ${user}    最初版本

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

 /**

  * &lt;b&gt;Summary: &lt;/b&gt;

  *      TODO 請在此處簡要描述此類所實現的功能。因為這項注釋主要是為了在IDE環境中產生tip協助,務必簡明扼要

  * &lt;b&gt;Remarks: &lt;/b&gt;

  *        TODO 請在此處詳細描述類的功能、調用方法、注意事項、以及與其它類的關係

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

 /** 

  * &lt;b&gt;Summary: &lt;/b&gt;

  *     構造一個 ${enclosing_type}  

  * &lt;b&gt;Remarks: &lt;/b&gt;

  *     構造類 ${enclosing_type} 的建構函式 ${enclosing_type}

  * ${tags} 

  */</template>

  <!-- GET方法注釋 -->

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

 /**

  * &lt;b&gt;Summary: &lt;/b&gt;

  *     擷取${bare_field_name}的值

  * @return ${bare_field_name} 

  */</template>

  <!-- SET方法注釋 -->

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

 /** 

  * &lt;b&gt;Summary: &lt;/b&gt;

  *     設定 ${bare_field_name} 的值 

  * @param ${param} 

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

 /**

  * &lt;b&gt;Summary: &lt;/b&gt;

  *     ${enclosing_method}(請用一句話描述這個方法的作用)

  * ${tags} 

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

 /** 

  * &lt;b&gt;Summary: &lt;/b&gt;

  *     代理方法 ${enclosing_method}

  * ${tags} 

  * ${see_to_target} 

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

 /** 

  * &lt;b&gt;Summary: &lt;/b&gt;

  *     複寫方法 ${enclosing_method}

  * ${tags} 

  * ${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}(請用一句話描述這個變數表示什麼) 

  */</template>

 </templates>

儲存為xml檔案,匯入即可

問題:日期格式不對。日期:Sep 14, 2010 時間:1:58:41 PM

辦法:

找到eclipse.ini 

裡面有-Duser.language=en 

改為-Duser.language=zh-cn即可


如:${date} ${time}  輸出的注釋格式為:2009-10-15 上午10:36:08

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.