1. 程式人生 > >Eclipse 中添加文檔註釋快捷鍵

Eclipse 中添加文檔註釋快捷鍵

導入 ces -- nts 模板 ext type alt false

例如:

/**
* @param
* @return

*/

快捷鍵為:ALT + SHIFT +J

想更換為其他的快捷鍵:

Window-->Preferences-->General-->Keys; 找到"add javadoc comment"更改自己喜歡的快捷鍵。

另外如果覺得註釋也不爽時也可以改改,修改的方法有兩種:

1.直接在eclipse給的模板下進行修改

2.自己編寫一個xml文檔導入進去

那就來先說說第一種方法吧:

打開eclipse

Window-->Preferences-->Java-->Code Style --> Code Templates --> Comments --> types --> Edit

/**
*
* 項目名稱:${project_name}
* 類名稱:${type_name}
* 類描述:
* 創建人:${user}
* 創建時間:${date} ${time}
* 修改人:${user}
* 修改時間:${date} ${time}
* 修改備註:
* @version
*
*/

第二種方法是:

點擊右邊的import按鈕選擇你寫好的模板.xml文件

下面是一個註釋行模板codetemplates.xml,可以直接導入使用。貼出源碼供大家參考一下

<?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">
/**
* 創建一個新的實例 ${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">
/**
* ${enclosing_method}(這裏用一句話描述這個方法的作用)
* TODO(這裏描述這個方法適用條件 – 可選)
* TODO(這裏描述這個方法的執行流程 – 可選)
* TODO(這裏描述這個方法的使用方法 – 可選)
* TODO(這裏描述這個方法的註意事項 – 可選)
* @param name
* @param @return 設定文件
* @return String DOM對象
* @Exception 異常對象
* @since CodingExample Ver(編碼範例查看) 1.1
*/
</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}
* 版權所有
*
*/
</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}(用一句話描述這個變量表示什麽)
*
* @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">
/**
*
* 項目名稱:${project_name}
* 類名稱:${type_name}
* 類描述:
* 創建人:${user}
* 創建時間:${date} ${time}
* 修改人:${user}
* 修改時間:${date} ${time}
* 修改備註:
* @version
*
*/</template>

</templates>

Eclipse 中添加文檔註釋快捷鍵