Eclipse Java註釋模板設置詳解
阿新 • • 發佈：2017-11-15
comment ons gmail const mail pack led dcom time
設置註釋模板的入口： 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註釋模板設置詳解