Eclipse Java 注释模板设置 code templates

超、凢脫俗 2022-06-16 04:50 184阅读 0赞

## 设置注释模板    ##

设置注释模板的入口： 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\}(用一句话描述这个变量表示什么)  
\*/

#### 构造函数标签： ####

/\*\*  
\* <p>Title: </p>  
\* <p>Description: </p>  
\* $\{tags\}  
\*/

#### **方法(Constructor & Methods)**标签： ####

/\*\*  
\* @Title: $\{enclosing\_method\}  
\* @Description: $\{todo\}(这里用一句话描述这个方法的作用)  
\* @param $\{tags\}    设定文件  
\* @return $\{return\_type\}    返回类型  
\* @throws  
\*/

#### 覆盖方法(Overriding Methods)标签： ####

/\* (非 Javadoc)  
\* <p>Title: $\{enclosing\_method\}</p>  
\* <p>Description: </p>  
\* $\{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" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/\*\*   
\* @Fields $\{field\} : $\{todo\}(用一句话描述这个变量表示什么)   
\*/   
</template><template autoinsert="true" context="gettercomment\_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/\*\*   
\* @return $\{bare\_field\_name\}   
\*/   
</template><template autoinsert="true" context="constructorcomment\_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/\*\*   
\* <p>Title:$\{file\_name\} </p>   
\* <p>Description: 构造函数</p>   
\* $\{tags\}   
\*/   
</template><template autoinsert="true" context="filecomment\_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" 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" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/\*\*   
\* @param $\{param\} 要设置的 $\{bare\_field\_name\}   
\*/</template><template autoinsert="true" context="typecomment\_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/\*\*   
\* @author $\{user\}   
\*   
\* $\{tags\}   
\*/</template><template autoinsert="true" context="delegatecomment\_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/\*\*   
\* $\{tags\}   
\* $\{see\_to\_target\}   
\*/</template><template autoinsert="true" context="overridecomment\_context" deleted="false" description="覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" 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" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/\*\*   
\* $\{tags\}   
\*/</template></templa   
<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment\_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/\*\*  
\* @Fields $\{field\} : $\{todo\}(用一句话描述这个变量表示什么)  
\*/  
</template><template autoinsert="true" context="gettercomment\_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/\*\*  
\* @return $\{bare\_field\_name\}  
\*/  
</template><template autoinsert="true" context="constructorcomment\_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/\*\*  
\* <p>Title:$\{file\_name\} </p>  
\* <p>Description: 构造函数</p>  
\* $\{tags\}  
\*/  
</template><template autoinsert="true" context="filecomment\_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" 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" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/\*\*  
\* @param $\{param\} 要设置的 $\{bare\_field\_name\}  
\*/</template><template autoinsert="true" context="typecomment\_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/\*\*  
\* @author $\{user\}  
\*  
\* $\{tags\}  
\*/</template><template autoinsert="true" context="delegatecomment\_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/\*\*  
\* $\{tags\}  
\* $\{see\_to\_target\}  
\*/</template><template autoinsert="true" context="overridecomment\_context" deleted="false" description="覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" 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" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/\*\*  
\* $\{tags\}  
\*/</template>

**例子2**：  
<?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">   
    /\*\*    
     \* 此方法描述的是：    
     \* @author: wangxiongdx@163.com    
     \* @version: $\{date\} $\{time\}    
     \*/    
    </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">   
    /\*\*    
     \* 此类描述的是：    
     \* @author: wangxiongdx@163.com    
     \* @version: $\{date\} $\{time\}     
     \*/    
    </template>   
</templates>   
<?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">  
    /\*\*  
     \* 此方法描述的是：  
     \* @author: wangxiongdx@163.com  
     \* @version: $\{date\} $\{time\}  
     \*/  
    </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">  
    /\*\*  
     \* 此类描述的是：  
     \* @author: wangxiongdx@163.com  
     \* @version: $\{date\} $\{time\}  
     \*/  
    </template>  
</templates>

本文来自CSDN博客，转载请标明出处：http://blog.csdn.net/ahhsxy/archive/2009/09/11/4542682.aspx