Eclipse 的模板:推荐一个好的内容

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

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

类型(Types)注释标签(类的注释):

/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author ${user}
* @date ${date}
*
* ${tags}
*/

字段(Fields)注释标签:

/**
* @Fields field:field:{todo}(用一句话描述这个变量表示什么)
*/
构造函数(Constructor)标签:

/**
* 创建一个新的实例 ${enclosing_type}.
*
* ${tags}
*/

方法(Methods)标签:

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

覆盖方法(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 paramtheparamthe{bare_field_name} to set
*/

要实现上面的注释模板,这需要将下面的配置文件导入就可以了:

<?xml version="1.0" encoding="UTF-8"?>
<templates>
<template
autoinsert="false"
context="filecomment_context"
deleted="false"
description="Comment for created Java files"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
name="filecomment">
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author ${user}
* @date ${date}
* @version V1.0
*/
</template>
<template
autoinsert="false"
context="typecomment_context"
deleted="false"
description="Comment for created types"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.typecomment"
name="typecomment">
/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author ${user}
* @date ${date}
*
* ${tags}
*/
</template>
<template
autoinsert="false"
context="fieldcomment_context"
deleted="false"
description="Comment for fields"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"
name="fieldcomment">
/**
* @Fields field:field:{todo}(用一句话描述这个变量表示什么)
*/
</template>
<template
autoinsert="false"
context="constructorcomment_context"
deleted="false"
description="Comment for created constructors"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
name="constructorcomment">
/**
* 创建一个新的实例 ${enclosing_type}.
*
* ${tags}
*/
</template>
<template
autoinsert="false"
context="methodcomment_context"
deleted="false"
description="Comment for non-overriding methods"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
name="methodcomment">
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 参数
* @return ${return_type} 返回类型
* @throws
*/
</template>
<template
autoinsert="true"
context="overridecomment_context"
deleted="false"
description="Comment for overriding methods"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
name="overridecomment">
/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
</template>
<template
autoinsert="true"
context="delegatecomment_context"
deleted="false"
description="Comment for delegate methods"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
name="delegatecomment">
/**
* ${tags}
* ${see_to_target}
*/
</template>
<template
autoinsert="false"
context="gettercomment_context"
deleted="false"
description="Comment for getter method"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
name="gettercomment">
/**
* @return ${bare_field_name}
*/
</template>
<template
autoinsert="true"
context="settercomment_context"
deleted="false"
description="Comment for setter method"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
name="settercomment">
/**
* @param paramtheparamthe{bare_field_name} to set
*/
</template>
</templates>

---------------------
作者:oO归去来兮Oo
来源:CSDN
原文:https://blog.csdn.net/paul342/article/details/52982585
版权声明:本文为博主原创文章,转载请附上博文链接!

最新文章

  1. 使用TextUtils.isEmpty简单化代码
  2. (转载)iOS 极光推送SDK 集成指南
  3. [转]ASP.NET MVC3 + EF 性能优化解决方案以及最优架构
  4. nginx伪静态
  5. 【bzoj3771】【xsy1728】Triple
  6. HDOJ/HDU 2539 点球大战(String.endsWith()方法的一个应用~)
  7. spring技术翻译开始
  8. 服务器端操作Cookie[2]
  9. Abstract Methods and Classes
  10. [Qt] fontawesome图标
  11. 一个非常不错的gridview 风格
  12. 双数组trie树的基本构造及简单优化
  13. hasResultError
  14. HTML5 scada 组态工具
  15. ue4动画蓝图
  16. Keepalived+LVS实现高可用负载均衡双主模式
  17. Kibana5.x界面简要介绍(含x-pack插件)
  18. PTA——天平找小球
  19. nginx记录post数据日志
  20. 在vue中如何动态修改title标签的值

热门文章

  1. css实现3D切换功能
  2. Retrofit的初次使用
  3. 粮草先行——Android折叠屏开发技术点番外篇之运行时变更处理原则
  4. C++11新特性之tie、tuple的应用
  5. spring Boot环境下dubbo+zookeeper的一个基础讲解与示例
  6. 【IIS】解决IIS无响应假死状态,asp突然无法访问重启后可以使用是什么原因
  7. 记录SoapUI使用说明
  8. .NET Core微服务之基于Jenkins+Docker实现持续部署(Part 1)
  9. RomUtil【Android判断手机ROM,用于判断手机机型】
  10. pycharm安装svn插件