Eclipse 设置注释模板

2022年3月2日 0 作者 小渔民

 

一、为何配置注释模板

在工作中我们需要在必要的地方添加注释以便于自己和其他人理解代码,这就是注释的主要功能,我们不希望发生几个月后只有上帝知道我们的代码是什么意思的情况,那将充分的证明代码不够优雅。

二、模板的内容是什么

模板的内容取决于我们自己或公司的注释规范,注释变化万千,但是我认为核心问题就是两个

  1. 精简且准确的描述代码的功能、作用、意义、注意事项等,这是最基本的要求
  2. 公司对注释的要求

三、如何配置

Eclipse 中提供了注释模板的功能,简单的配置之后就可以自定义所有注释的样式和内容,这种一劳永逸的事,还是有必要尝试一下的。

首先打开Eclipse ,依次点击 

Window ——> Preference

java ——> Code Style ——> CodeTemplates ——> Comments 

即可看见模板的配置窗口

我们可以尝试选择一个 ,比如点击 Files 然后点击 Edit ,即可看见模板配置的窗口

这里就是我们配置的地方,在配置之前,需要先想清楚,我们的文件中需要哪些注释,这是一件可以想清楚在做的事情

四、模板配置演示

首先我们要清楚需要配置哪些东西,我们拿 java 文件来举例,起码需要类注释和方法注释两种常用的注释,其要求如下

  1. 类注释应该主要表述当前类服务于那个模块,或者是哪些功能,它是何时创建,谁是它的作者
  2. 而方法的注释应该包括创建时间、作者、参数、含义或功能等等

接下来我简单的配置一下这两种注释

首先是类注释:

选择 Comments 中的 Types ,然后点击 Edit ,

 将如下内容替换掉原本的内容

/**    * @ClassName:  ${type_name}    * @Description:${todo}(描述这个类的作用)    * @author: 你的名字 * @date:   ${date} ${time}     * ${tags}   * @Copyright:   */

然后点击 Apply and Close ,到这里我们对于类的注释模板就配置完成了,接下来我们测试一下是否配置成功

首先创建一个类,在类中输入 /** 然后点击 enter 即可看见效果

至此,类的模板就配置成功,接下来就是配置其他类型的注释,下面给大家一个参考

五、模板配置参考

  • 文件(Files)注释标签:
/**
* @Title:  ${file_name}
* @Package ${package_name}
* @Description:    描述
* @author: XXX
* @date:   ${date} ${time}
* @Copyright:
*/
  • 类型(Types)注释标签(类的注释):
/**
* @ClassName:  ${type_name}
* @Description:${todo}(描述这个类的作用)
* @author: XXX
* @date:   ${date} ${time}
* ${tags}
* @Copyright:
*/
  • 字段(Fields)注释标签:
/**
* @Fields ${field} : ${todo}(这个变量表示什么)
*/
  • 构造函数标签:
/**
* @Title:  ${enclosing_type}
* @Description:    ${todo}(描述这个方法的作用)
* @param:  ${tags}
* @throws
*/
  • 方法(Methods)标签:
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(描述这个方法的作用)
* @param: ${tags}
* @return: ${return_type}
* @throws
*/
  • 覆盖方法(Overriding Methods)标签:
/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
  • 代表方法(Delegate Methods)标签:
/**
* ${tags}
* ${see_to_target}
*/
  • getter方法标签:
/**
* @Title:  ${enclosing_method} <BR>
* @Description: please write your description <BR>
* @return: ${field_type} <BR>
*/
  • setter方法标签:
/**
* @Title:  ${enclosing_method} <BR>
* @Description: please write your description <BR>
* @return: ${field_type} <BR>
*/

原文链接:https://blog.csdn.net/qq_36623327/article/details/104555893