IDEA类和方法注释模板设置（非常详细）

最新推荐文章于 2025-07-03 16:20:32 发布
最新推荐文章于 2025-07-03 16:20:32 发布
阅读量332 收藏 1
点赞数
分类专栏： 项目
博主搜集资料整理出一份完整的IDEA注释模板并分享。设置的注释模板采用Eclipse格式，文中将贴出Eclipse的类注释模板和方法注释模板，旨在让大家省事。

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

IDEA自带的注释模板不是太好用，我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家，我不是专业玩博客的，写这篇文章只是为了让大家省事。

这里设置的注释模板采用Eclipse的格式，下面先贴出Eclipse的注释模板，我们就按照这种格式来设置：

类注释模板：
在这里插入图片描述
方法注释模板：
在这里插入图片描述

【IDEA】IDEA配置类、方法注释模板
baidu_21035953的博客
07-16 7348
打开 IDEA 的Settings，点击，点击右边File选项卡，在下面找到的Class，将注释模板配置到图中红框内后，点击Apply按钮，而后点击OK按钮，即可完成类注释配置本文提供的示例模板中，说明了类名称、作者、时间和类描述，IDEA 支持的所有的模板参数在下方的 Description中被列出，如下图保存后，当你创建一个新的类的时候就会自动添加类注释。如果你想对接口也生效，按照上述配置，配置Files选项卡中的Interface项即可。
IDEA类和方法注释模板设置（超详细教程）
2401_89172797的博客
12-20 1188
create:YEAR−HOUR{MINUTE}**/方法模板注释：end@Datetimedate@Paramparam@returnreturn**/
超详细设置Idea类注释模板和方法注释模板
热门推荐
super-pf的博客
12-11 11万+
网上找了一下，没有很详细且正确介绍Idea配置注释模板的，于是结合多篇文章自己琢磨整理出如下。设置类注释模板1.选择File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header. 2.在右边空白处，编写自己的模板即可，注意Scheme是模板的生效范围，可选变量在description有介绍，附图中本人使用的模板（${U
IDEA类和方法注释模板设置-保姆教程
最新发布
5年金融行业+3年工业领域工作经验，技术分享、互助学习
07-03 1615
在讲解怎么设置类和方法注释模板前，先简单介绍下Javadoc标准，因为注释规范，最终和Javadoc标准契合，效果最好，不仅方便后续出接口文档描述，也是业界的统一标准，更易于接受。Javadoc 标准标签列表标签名用途说明@author指定类、接口或方法的作者@version指定类、接口的版本信息@since表示该类或方法从哪个版本开始存在一般就记录时间）@param描述方法参数的含义。
idea 设置类的注释模板
记录各种Bug解决案例及日常学习内容
04-20 766
在Idea工具中，点击File >> Settings >> Editor >> File and Code Templates >> Files，选择class （或者直接按快捷键：Ctrl + Alt + S） 在右侧根据需要输入模板内容： /** *@Author: JYC *@Title: ${NAME} *@Description: TODO *@Date: ${DATE} ${TIME} */ 点击 OK进行保存 新建.
idea设置注释模板
zf_csdn123的博客
06-16 3332
idea注释模板配置
IDEA这样配置注释模板-开发必备
guoweiting的博客
04-02 1090
一、类注释 打开 IDEA 的Settings，点击Editor-->File and Code Templates，点击右边File选项卡下面的Class，在其中添加图中红框内的内容： /** * @author jitwxs * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME} */ 在我提供的示例模板中，说明了作者和时间，IDEA 支持的所有的模板参数在下方的Description中被列出来。 保存后，当你创建一个新的类的时候就会自动添加...
IDEA 类和方法注释模板设置(MAC版).pdf
08-19
以下将详细介绍如何在MAC版的IntelliJ IDEA中设置类和方法的注释模板。 首先，我们来看如何设置类注释模板。在IDEA的左侧菜单栏中，点击`Intellij IDEA`，然后选择`Preferences` -> `Editor` -> `File and Code ...
Idea设置：注释模板
love_study1314的博客
12-12 735
本文介绍idea怎么设置类注释和方法注释模板
IDEA 设置注释模板
冰糖的博客
02-18 4546
IDEA 设置注释模板新建文件时带上注释已有文件生成注释 新建文件时带上注释 这里以Java文件为例，其他类似。 用到了Record和AnnotationType的也可以选上。 已有文件生成注释 新建组（非必须，也可以直接在Java组下面新建模板） 在指定组下面创建模板 配置模板 设置变量 ** * @description: TODO * @author $user$ * @date $date$ $time$ * @version 1.0.0 */ 设置方法注释模板 操作类
IDEA设置注释模板
qq_35963482的博客
03-21 1122
更有B格的编写代码
Idea-设置注释模板
兴趣是最好的老师
07-02 355
Idea-设置注释模板
idea注释模板设置
qq_41786582的博客
06-25 260
Idea自定义注释 1.1、以配置Class的注释为例，其他文件的类似，打开File - settings之后，找到下图的位置，选中Class后修改备注，变量和参数跟eclipse差不多就不多讲了。配置完这里后再新建class就会应用新的注释模板了，但是我也只能发现新建的时候应用，如果已有方法还是不会自动引用，只能手动维护 2.模板 /** TODO @version 1.0 @author ${USER} @date ${DATE} ${TIME} */ 3.方法的注释 3.1新建的组
IDEA设置类注释模板
Ricardo的树屋
08-26 196
1.设置类注释模板 （一）打开设置界面，或者快捷键Ctrl+Alt+S (二)其余注释模板同理 /** *@ClassName ${NAME} *@Description: //TODO ${Description} *@Author wyq *@Date ${DATE} ${TIME} */ （三）使用示例 （1）新创建一个类，输入类名 （2）输入描述 （3）生成结果显示 ...
Intellij IDEA 注释模板设置
weixin_44981707的博客
06-26 2926
Intellij IDEA 注释模板设置1. idea 类注释2. 方法注释模板3. 字段注释模板 1. idea 类注释   打开 idea：file->setting->Editor->Filr and Code Templates->Includes->File Header   类注释模板： /** * @className: ${NAME} * @description: ${TODO} * @author ${USER} * @date ${DA
IDEA 类和方法注释模板设置
12-13
在 IntelliJ IDEA 中，为了提高代码文档化效率，你可以自定义类和方法的注释模板。这样每次创建新类或方法时，只需填写少量内容，IDEA就会自动填充完整的注释。以下是设置注释模板的基本步骤： 1. 打开 IntelliJ IDEA，选择 "File" -> "Settings" (Windows/Linux) 或 "IntelliJ IDEA" -> "Preferences" (macOS)。 2. 寻找并点击 "Editor"，然后选择 "Code Style" -> "Live Templates"。 3. 在左侧栏中找到 "General", "JavaDoc" 或者更具体的语言区域（如 "Java"），展开它。 4. 双击 "Code Folders" 来编辑现有模板，或者点击 "+" 创建新的模板。例如，为类和方法分别设置模板，可以创建两个模板，如 "Class Comment" 和 "Method Comment"。 5. 编辑模板内容。对于 `@param`、`@return` 等部分，可以用 `${...}` 标记表示需要用户输入的部分。例如，一个简单的类注释模板可能如下： ``` /** * ${CLASS_NAME} - 描述类的功能 * * ${DESCRIPTION} */ ``` 6. 对于方法模板，可能会包含输入参数名和类型的提示： ``` /** * ${METHOD_NAME}(参数列表) * - 描述方法的作用 * * @param 参数1_name ${PARAM1_TYPE} 参数1描述 * @param 参数2_name ${PARAM2_TYPE} 参数2描述 * ... * @return 返回值类型 返回值描述 */ ``` 7. 设置完成后，记得保存更改。现在当你创建新的类或方法时，输入相应的触发短语（比如 "class" 或者 "method"），然后按回车键，IDEA 就会基于你的模板生成注释了。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值