开发工具Eclipse-代码注释模板_软件代码注释模板-优快云博客

本文链接：https://blog.youkuaiyun.com/cl11992/article/details/79526303

本文介绍如何在Eclipse中配置各类代码元素的注释模板，包括文件、类、字段、构造函数、方法等，帮助开发者提高代码规范性和文档质量。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

点击菜单Window->Preferences弹出首选项设置窗口
展开左侧Java->Code Style->Code Template选项列表，就可以看到所有需设置注释的元素了
展开右侧模板选项Comments，可以看到可以设置的注释模板类型，包含Files,Types,Fields,Constructors,Methods等内容

点击Types，下方Pattern区域会显示类注释模板内容，点击右则的Edit按钮可以对注释模板内容进行修改

注意，这里要勾选，表示在新建类时将时自动添加注释信息

在实际开发过程中，新建一个类以后，通过输入/**，然后回车即自动按照刚才定义的注释模板格式补齐注释内容，也可以按shift+alt+j快捷键完成该动作

1.文件(Files)注释标签

/**
 * Copyright (C) 2016-Now XXXX All rights reserved.
 * XXXX对本内容拥有著作权，禁止外泄，禁止未经授权使用。
 */

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

/**
 * <p>标题: ${type_name}</p>
 * <p>描述: </p>
 * <p>公司: XXXX www.xxxxxxxxx.com</p>
 * @author ${user}
 * @date ${date} ${time}
 * ${tags}
 */

3.字段(Fields)注释标签

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

4.构造函数标签

/**   
 * @Title:构造方法   
 * @Description:${todo}(这里用一句话描述这个方法的作用)   
 * ${tags}
 */

5.方法(Methods)标签

/**
 * ${todo}(这里用一句话描述这个方法的作用) 
 * ${tags}
 */

6.覆盖方法(Overriding Methods)标签

/**   
 * <p>描述: ${todo}(这里用一句话描述这个方法的作用) </p>   
 * ${tags}   
 * ${see_to_overridden}   
 */

7.代表方法(Delegate Methods)标签

/**
 * ${tags}
 * ${see_to_target}
 */

8.getter方法标签

/**
 * @return the ${bare_field_name}
 */

9.setter方法标签

/**
 * @param ${param} the ${bare_field_name} to set
 */