设置注释的模板，类的注释提示模板

 

注释规范对于程序员而言尤为重要，有以下几个原因：

一个软件的生命周期中，80%的花费在于维护。

几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护

注释规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码

统一的注释规范可以快速生成文档说明

 

 

Java 程序有两类注释：归档（文本/文档）注释(document comments)和实现注释(implementation comments)。

归档注释：采用java doc（/**…*/）形式进行注释，主要用于通过javadoc 工具转换成HTML 文件。

实现注释：只能使用/*…*/或//形式进行注释，主要用于方法内部的注释。如果需要多行使用/*…… */形式，如果为单行是用//……形式的注释。

 

 

 

1.技巧：选中你要加注释的方法或类，按 Alt + shift + J。

 

2.设置注释的模板：Window –> Java –> Code Style –> Code Templates –> Comments –> types –> Edit

 

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

 

 

 

1、  具体操作

(1)在eclipse中，打开Window->Preference->Java->Code Style->Code Template

(2)然后展开Comments节点就是所有需设置注释的元素，参照2注释规范对应设置即可

2、  注释规范

 

所有的源文件都应该在开头有一个注释，其中列出类名、版本信息、日期和版权声明。

 

如下：

  1. /**
  2. * 文件名: 
  3. * 描述: (用一句话描述该文件做什么) 
  4. * 开发人员： 
  5. * 创建时间： 
  6. */

 

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

 

 

 

每一个类都要包含如下格式的注释，以说明当前类的功能等。

 

方式一：简单的注释，不提供生成的变量。

 

  1.  /** 
  2. * 类名: 
  3. * 描述: (这里用一句话描述这个类的作用) 
  4. * 开发人员： 
  5. * 创建时间：  
  6. * 发布版本： 
  7. */

 

方式二：中文注释，提供简单的生成变量。

 

  1. /**
  2. * 类名: ${file_name}
  3. * 包名 : ${package_name}
  4. * 详细描述: ${todo}(用一句话描述该文件做什么)
  5. * 开发人员： souvc 
  6. * 开发日期：${date}
  7. * 发布版本： V1.0
  8. */

 

方式三：英文注释，提供生成变量。

 

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

 

 方式四：增加换行功能。

 

  1. /**
  2. * 类名: ${file_name} <br/>
  3. * 包名 : ${package_name} <br/>
  4. * 详细描述: ${todo}(用一句话描述该文件做什么) <br/>
  5. * 开发人员： souvc   <br/>
  6. * 开发日期：${date} <br/>
  7. * 发布版本： V1.0  <br/>
  8. */

 

方式五：

 

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

 

 

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

 

 

 

成员变量和常量需要使用java doc形式的注释，以说明当前变量或常量的含义

 

文件(Files)注释标签：

  1. /**
  2. * 文件名: ${file_name}
  3. * 描述: (用一句话描述该文件做什么) 
  4. * 开发人员： liuhf
  5. * 创建时间： ${date} ${time}
  6. */

 

  1. 文件(Files)注释标签：
  3. /**  
  4. * @Title: ${file_name}
  5. * @Package ${package_name}
  6. * @Description: ${todo}(用一句话描述该文件做什么)
  7. * @author souvc  
  8. * @date ${date} ${time}
  9. * @version V1.0  
  10. */

 

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

 

 

 每一个构造方法都要包含如下格式的注释，以说明此构造方法的功能等。

 

  1. /** 
  2.  * 构造方法名: 
  3.  * 描述: (这里用一句话描述这个方法的作用)
  4.  * 开发人员：
  5.  * 创建时间：
  6.  * 说明参数含义
  7.  */

 

 

 

每一个方法都要包括当前方法的用途，当前方法参数的含义，当前方法返回值的内容和抛出异常的列表，如下注释格式：

 

方式一：

 

  1. /**     
  2. * 方法名：
  3. * 详述：（简单方法可一句话概述）
  4. * 修改记录+版本号：修改者，修改描述（一句话）
  5. * 开发人员：
  6. * 创建时间：
  7. * 说明参数含义
  8. * 说明返回值含义
  9. * 说明发生此异常的条件
  10. */

   

方法二：

 

  1. /**     
  2. * 方法名：${enclosing_method}</br>
  3. * 详述：${todo}（简单方法可一句话概述）</br>
  4. * 开发人员：liuhf </br>
  5. * 创建时间：${date}  </br>
  6. * ${tags}
  7. * @throws 
  8. */

 

 

…

 

版权声明：本文为liuhongfeng原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://www.cnblogs.com/liuhongfeng/p/4539816.html