Eclipse中Java代码如何注释

Eclipse中Java代码注释方法及模板设置

一、基础注释快捷键

1. 单行注释

• 操作方式：选中要注释的代码行（或光标置于行首），按Ctrl + /（Windows/Linux/Mac通用）。
• 效果：代码行前添加//，如// 这是单行注释。
• 取消注释：再次按下相同快捷键，//会被移除。

2. 多行注释

• 操作方式：选中多行代码，按Ctrl + Shift + /。
• 效果：代码块被/*和*/包裹，如：

  /*
   * 这是多行注释
   * 第二行注释
   */
  

• 取消注释：按Ctrl + Shift + \，可快速移除多行注释符号。

3. 文档注释（Javadoc）

• 操作方式1：在类、方法或字段的上一行输入/**，然后按Enter键，Eclipse会自动生成文档注释模板。
• 操作方式2：将光标置于类、方法或字段名上，按Alt + Shift + J快速生成。
• 效果：生成包含@param（参数说明）、@return（返回值说明）、@throws（异常说明）等标签的模板，如：

  /**
   * 计算两个整数的和
   * @param a 第一个整数
   * @param b 第二个整数
   * @return 两个整数的和
   */
  public int add(int a, int b) {
      return a + b;
  }
  

• 注意：文档注释会被Eclipse的Javadoc工具识别，用于生成API文档。

二、自定义注释模板（自动添加作者、时间等信息）

Eclipse支持通过模板设置，在创建类、方法时自动生成注释，避免手动重复输入。

1. 模板设置入口

点击顶部菜单栏Window→Preferences→Java→Code Style→Code Templates，展开Comments节点，可看到各类注释模板（如Files、Types、Methods等）。

2. 常见模板修改示例

• 文件注释（Files）：修改new Java files模板，添加作者、日期、版权信息：

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

• 类注释（Types）：修改Types模板，描述类功能：

  /**
   * @ClassName: ${type_name}
   * @Description: ${todo}(描述这个类的核心功能)
   * @author: ${user}
   * @date: ${date} ${time}
   */
  

• 方法注释（Methods）：修改Methods模板，包含参数、返回值说明：

  /**
   * @Title: ${enclosing_method}
   * @Description: ${todo}(描述这个方法的具体功能)
   * @param: ${tags}（参数列表，如@param name 参数名）
   * @return: ${return_type}（返回值类型及说明）
   * @throws: ${throws}（可能抛出的异常）
   */
  

3. 使用变量增强模板

模板中可使用Eclipse内置变量，如：

• ${user}：当前系统用户名；
• ${date}：当前日期（如2025-11-11）；
• ${time}：当前时间（如14:30:00）；
• ${type_name}：类名；
• ${method_name}：方法名。
  这些变量会根据代码上下文自动填充，减少手动修改工作量。

4. 导入/导出模板

• 导出模板：在Code Templates页面点击Export，将模板保存为.xml文件，方便备份或分享给团队成员。
• 导入模板：点击Import，选择备份的.xml文件，即可恢复模板设置。

三、注意事项

• 单行注释：每行//后需空一格，提高可读性（如// 这是注释而非//这是注释）。
• 多行注释：/*和*/必须成对出现，注释内容中的*可选，但建议每行开头添加*，增强视觉区分。
• 文档注释：/**和*/之间的内容会被Javadoc工具解析，标签（如@param、@return）需按规范书写，否则无法生成正确的API文档。