Eclipse Java注釋模板設定詳解

標籤：節點   入口   tag   insert   cto   templates   一句話   name   row   

設定注釋模板的入口： 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注釋模板設定詳解