Idea和eclipse设置类注释和方法注释的方法

太过爱你忘了你带给我的痛 2022-04-16 06:45 274阅读 0赞

首先来说说eclipse的方法吧,话不多说,直接上教程

设置注释模板的入口：Window->Preference->Java->Code Style->Code Template 
    然后展开Comments节点就是所有需设置注释的元素。
    
    文件(Files)注释标签：
    /**
    * @Title: ${file_name}
    * @Package ${package_name}
    * @Description: (描述该文件做什么)
    * @author ${user}
    * @date ${date} ${time}
    * @version V1.0
    */
    类型(Types)注释标签（类的注释）：
    /**
    * @ClassName: ${type_name}
    * @Description: (描述这个类的作用)
    * @author ${user}
    * @date ${date} ${time}
    *
    * ${tags}
    */
    字段(Fields)注释标签：
    /**
    * @Fields ${field} : ${todo}(描述这个变量表示什么)
    */
    构造函数(Constructor)标签：
    /**
    * 创建一个新的实例 ${enclosing_type}.
    *
    * ${tags}
    */
    方法(Methods)标签：
    /**
    * @Title: ${enclosing_method}
    * @Description: (描述这个方法的作用)
    * ${tags}
    * @return ${return_type}
    */
    覆盖方法(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} the ${bare_field_name} to set
    */

然后重点是idea的类的注释和方法的注释

![20181118235340363.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70][]

图中是我已经设置好了的,右边的代码为:

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
    #parse("File Header.java")
    /**
    * @program: ${PROJECT_NAME}
    *
    * @description: ${description}
    *
    * @author: hw
    *
    * @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
    **/
    public class ${NAME} {
    }

@author为你自己的名字或者标志之类的,然后我们来看看效果

![20181119001415397.png][]![20181119001429626.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 1][]

这样就可以直接出来和类相关的信息了,接下来是方法的注释

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 2][]

点击+号选择第二个

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 3][]

![20181119001736318.png][]

随便输入一个名字,然后选中刚刚创建的点击+号选择第一个

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 4][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 5][]

输入相关信息,点击下面的Define,选中咱们的java

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 6][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 7][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 8][]

设置好了之后就行了,测试效果

![20181119002220929.png][]

然后贴上注释代码

** @Description: $description$
        * @Param: $params$
        * @return: $returns$
        * @Author: hw
        * @Date: $date$
        */

[20181118235340363.png]: /images/20220416/5594f43b12cd4922b0731bee54f95b6e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70]: /images/20220416/df9f8a754e1b49c5815f184d844e6cf1.png
[20181119001415397.png]: https://img-blog.csdnimg.cn/20181119001415397.png
[20181119001429626.png]: /images/20220416/1a68e45d858b4071974d486184f97737.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 1]: /images/20220416/f534d2ab85454492890a59f4089dff48.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 2]: /images/20220416/df9bb98774944e7489d7f6ada2ab04bb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 3]: /images/20220416/d5d3e673dee748d69d10eee2f082e14c.png
[20181119001736318.png]: /images/20220416/6b5888f21e03456080795a01d3fb38b8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 4]: /images/20220416/79a27d31a52f4fdcbc4332ff5dc86a11.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 5]: /images/20220416/efdfb93f4e3a4b92b3bfcf0ce3a2aeee.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 6]: /images/20220416/31767a11a9164a2c8516b02939da78db.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 7]: /images/20220416/732192189236488fb4e069d14b083b9b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTk0MTQ2_size_16_color_FFFFFF_t_70 8]: /images/20220416/315b1e5d826242b1936f0078c6639cbf.png
[20181119002220929.png]: /images/20220416/3ad882500b144969ab30401eeae90878.png