Eclipse注释模板设置

逃离我推掉我的手 2023-10-10 12:52 143阅读 0赞

设置注释模板的入口：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。本文将每一个元素逐一给大家介绍一下。

文件(Files)注释标签：

  1. /**
  2. * @Title: ${file_name}
  3. * @Package ${package_name}
  4. * @Description: ${todo}(用一句话描述该文件做什么)
  5. * @author ${user}
  6. * @date ${date}
  7. * @version V1.0
  8. */

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

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

字段(Fields)注释标签：

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

构造函数(Constructor)标签：

  1. /**
  2. * 创建一个新的实例 ${enclosing_type}.
  3. *
  4. * ${tags}
  5. */

方法(Methods)标签：

  1. /**
  2. * @Title: ${enclosing_method}
  3. * @Description: ${todo}(这里用一句话描述这个方法的作用)
  4. * @param ${tags}    参数
  5. * @return ${return_type}    返回类型
  6. * @throws
  7. */

覆盖方法(Overriding Methods)标签：

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

代理方法(Delegate Methods)标签：

  1. /**
  2. * ${tags}
  3. * ${see_to_target}
  4. */

getter方法标签：

  1. /**
  2. * @return ${bare_field_name}
  3. */

setter方法标签：

  1. /**
  2. * @param paramtheparamthe{bare_field_name} to set
  3. */

发表评论

表情：
评论列表 （有 0 条评论，143人围观）

还没有评论，来说两句吧...

相关阅读