Eclipse Java注釋模板設置詳解

原文：https://blog.csdn.net/ahhsxy/article/details/4542682

設置注釋模板的入口： 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}
*/

簡單模板例子：

<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注釋" enabled="true"  name="fieldcomment">/**
* @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼)
*/
</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注釋" enabled="true"  name="gettercomment">/**
 * @return ${bare_field_name}
 */
 </template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="創建的構造函數的注釋" enabled="true"  name="constructorcomment">/**
* <p>Title:${file_name} </p>
* <p>Description: 構造函數</p>
* ${tags}
*/
</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已創建的 Java 文件的注釋" enabled="true"  name="filecomment">/**  
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句話描述該文件做什麼)
* @author DAIGUANGJIU   
* @date ${date} ${time}
* @version V1.0  
*/
 </template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注釋" enabled="true"  name="settercomment">/**
 * @param ${param} 要設置的 ${bare_field_name}
 */</template><template autoinsert="true" context="typecomment_context" deleted="false" description="創建的類型的注釋" enabled="true"  name="typecomment">/**
 * @author ${user}
 *
 * ${tags}
 */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注釋" enabled="true"  name="delegatecomment">/**
* ${tags}
* ${see_to_target}
*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆蓋方法的注釋" enabled="true"  name="overridecomment">/** (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆蓋方法的注釋" enabled="true"  name="methodcomment">/**
 * ${tags}
 */</template></templa

例子2：

<?xml version="1.0" encoding="UTF-8"?>
<templates>
	
	<template 
				autoinsert="false" 
			  	context="constructorcomment_context" 
				deleted="false" 
				description="Comment for created constructors" 
				enabled="true" 
				
				name="constructorcomment">
	/**
	 * 創建一個新的實例 ${enclosing_type}.
	 *
	 * ${tags}
	 */
	</template>
	
	<template 
				autoinsert="true" 
				context="settercomment_context"
				deleted="false" 
				description="Comment for setter method" 
				enabled="true" 
				 
				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" 
				 
				name="methodcomment">
	/**
	 * 此方法描述的是：
	 * @author: wangxiongdx@163.com
	 * @version: ${date} ${time}
	 */
	</template>
	
	
	<template 
				autoinsert="true" 
				context="delegatecomment_context" 
				deleted="false" 
				description="Comment for delegate methods" 
				enabled="true" 
				 
				name="delegatecomment">
	/**
	 * ${tags}
	 * ${see_to_target}
	 */
	</template>
	
	
	<template
				autoinsert="false" 
				context="filecomment_context" 
				deleted="false" 
				description="Comment for created Java files" 
				enabled="true" 
				 
				name="filecomment">
	/**
	 * 文件名：${file_name}
	 *
	 * 版本信息：
	 * 日期：${date}
	 * Copyright 足下 Corporation ${year} 
	 * 版權所有
	 *
	 */
	</template>
	
	
	<template 
				autoinsert="false" 
				context="gettercomment_context" 
				deleted="false" 
				description="Comment for getter method" 
				enabled="true" 
				 
				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" 
				 
				name="overridecomment">
	/* (non-Javadoc)
	 * ${see_to_overridden}
	 */
	</template>
	
	
	<template 
				autoinsert="false" 
				context="fieldcomment_context" 
				deleted="false" 
				description="Comment for fields" 
				enabled="true" 
				 
				name="fieldcomment">
	/**
	 * ${field}:${todo}（用一句話描述這個變量表示什麼）
	 *
	 * @since Ver 1.1
	 */
	</template>
	
	
	<template 
				autoinsert="false" 
				context="typecomment_context" 
				deleted="false" 
				description="Comment for created types" 
				enabled="true" 
				 
				name="typecomment">
	/**
	 * 此類描述的是：
	 * @author: wangxiongdx@163.com
	 * @version: ${date} ${time} 
	 */
	</template>
 
 </templates>

最後更新：2017-04-02 06:52:05

Eclipse Java注釋模板設置詳解

上一篇： Eclipse快捷鍵大全

下一篇： rhel6 64 bit flush plugin

相關內容

熱門內容

最新內容