Eclipse Learning Note (iii): Comment Template

How to edit a comment template:window->preference->Java->code style->code template and then expand The comments node is all the elements that need to be annotated.

The Code node refers to the content of the generated auto-generated block.

1. Document (files) Note tags:

1 /**  2 * All rights Reserved, designed by Android_robot3 * @Title: ${file_name}4 * @Package ${package_name}5 * @Description: ${todo} (describe what the file does in a word)6  * @author: Android_robot7 * @date: ${date} ${time}8  * @versionV8.09  */

2. Type (Types) Comment Label (note for Class):

1     /**   2      * @ClassName:  ${type_name}   3     * @Description: ${todo} (here is a sentence describing the role of this class)    4 @author: android_robot  5* @date: ${date} $          {Time}    6      *   7     * ${tags}   8*/        

3. Field Comment Label:

1     /**   2      * @Fields ${field}: ${todo} (describe what this variable means in a sentence   )3      * /   

4. Constructor Tags:

1 /**   2 * @Title:  ${enclosing_type}   3  * @Description:    ${todo} (here is a word describing the effect of this method)    4@param:  ${tags}  5@ Throws   6  * /

5. Method (Methods) Tags:

    /**         * @Title: ${enclosing_method}        * @Description: ${todo} (here is a word describing the function of this        method)@param: $ {tags}            @return : ${return_type}            @throws        */  

6. Overlay method (overriding Methods) Label:

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

7. Delegate method (Delegate Methods) Label:

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

8.getter Method Label:

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

9.setter Method Label:

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

Eclipse Learning Note (iii): Comment Template