Eclipse自定义注释风格

阳光穿透心脏的1/2处 2022-05-14 12:34 227阅读 0赞

# 一、简介 #

**设置注释模板的入口：Window->Preference->[Java][]\->Code Style->Code Template**

**然后展开Comments节点就是所有需设置注释的元素了！**

**然后点击选中的注释模块，点击edit就可以设置了**

![70][]

![70 1][]

下面我们来简单解释一下这些注释的意思和推荐的模板

1、文件(Files)注释标签

> Files标签是对新建的文件的说明，出现在文件最上面

*  **推荐注释风格：**

/**   
     * Copyright © ${year} eSunny Info. Tech Ltd. All rights reserved.
     * 
     * 功能描述：
     * @Package: ${package_name} 
     * @author: ${user}   
     * @date: ${date} ${time} 
     */

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

> Types标签是对类Class的一个说明，出现在类上面

*  **推荐注释风格：**

/**   
    * Copyright: Copyright (c) ${year} LanRu-Caifu
    * 
    * @ClassName: ${file_name}
    * @Description: 该类的功能描述
    *
    * @version: v1.0.0
    * @author: ${user}
    * @date: ${date} ${time} 
    *
    */

3、字段(Fields)注释标签

> Fields标签是对变量字段的说明

*  **推荐注释风格：**

// @Fields ${field} : ${todo}

4、构造函数(Constructors)标签

> Constructors标签是对类的构造函数的说明

*  **推荐注释风格：**

/**   
    * @Function: ${file_name}
    * @Description: 该函数的功能描述
    *
    * @param:参数描述
    * @version: v1.0.0
    * @author: ${user}
    * @date: ${date} ${time} 
    */

5、方法(Methods)标签

> Methods标签是对函数方法的说明

*  **推荐注释风格：**

/**   
    * @Function: ${file_name}
    * @Description: 该函数的功能描述
    *
    * @param:描述1描述
    * @return：返回结果描述
    * @throws：异常描述
    *
    * @version: v1.0.0
    * @author: ${user}
    * @date: ${date} ${time} 
    *
    */

6、覆盖方法(Overriding Methods)标签

> Overriding Methods标签是对覆盖方法的说明

*  **推荐注释风格：**

/** 
    * ${see_to_overridden}  
    * @Function: ${file_name}
    * @Description: 该函数的功能描述
    *
    * @param:描述1描述
    * @return：返回结果描述
    * @throws：异常描述
    *
    * @version: v1.0.0
    * @author: ${user}
    * @date: ${date} ${time} 
    *
    */

7、代表方法(Delegate Methods)标签

*  **推荐注释风格：**

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

8、getter方法标签

*  **推荐注释风格：**

/**
     * @return the ${bare_field_name}
     */

9、setter方法标签

*  **推荐注释风格：**

/**
     * @param ${param} the ${bare_field_name} to set
     */

[Java]: https://link.jianshu.com/?t=http://lib.csdn.net/base/javase
[70]: /images/20220514/19682dac8125486ea9e715f3e277b864.png
[70 1]: /images/20220514/9112a034baac430d8eeb47f2f7ab2c1f.png