eclipse学习笔记：注释模板

Posted 2020-08-29 Mr_邓

编辑注释模板的方法：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。

code节点是指生成的自动生成的代码块的内容。

1.文件(Files)注释标签：

 

1 /**  
2  * All rights Reserved, Designed By android_Robot   
3  * @Title:  ${file_name}   
4  * @Package ${package_name}   
5  * @Description:    ${todo}(用一句话描述该文件做什么)   
6  * @author: Android_Robot     
7  * @date:   ${date} ${time}   
8  * @version V8.0     
9  */

 

2.类型(Types)注释标签（类的注释）：

1     /**   
2      * @ClassName:  ${type_name}   
3      * @Description:${todo}(这里用一句话描述这个类的作用)   
4      * @author: Android_Robot  
5      * @date:   ${date} ${time}   
6      *   
7      * ${tags}   
8      */  

3.字段(Fields)注释标签：

1     /**   
2      * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)   
3      */   

4.构造函数标签：

1 /**   
2  * @Title:  ${enclosing_type}   
3  * @Description:    ${todo}(这里用一句话描述这个方法的作用)   
4  * @param:  ${tags}  
5  * @throws   
6  */ 

5.方法(Methods)标签：

    /**   
     * @Title: ${enclosing_method}   
     * @Description: ${todo}(这里用一句话描述这个方法的作用)   
     * @param: ${tags}      
     * @return: ${return_type}      
     * @throws   
     */  

6.覆盖方法(Overriding Methods)标签:

1     /**   
2      * <p>Title: ${enclosing_method}</p>   
3      * <p>Description: </p>   
4      * ${tags}   
5      * ${see_to_overridden}   
6      */  

7.代表方法(Delegate Methods)标签：

    /**  
     * ${tags}  
     * ${see_to_target}  
     */  

8.getter方法标签：

    /**  
     * @Title:  ${enclosing_method} <BR>  
     * @Description: please write your description <BR>  
     * @return: ${field_type} <BR>  
     */  

9.setter方法标签：

/**  
 * @Title:  ${enclosing_method} <BR>  
 * @Description: please write your description <BR>  
 * @return: ${field_type} <BR>  
 */