IDEA类和方法注释模板设置

本文介绍如何在IntelliJ IDEA中自定义类和方法的注释模板,包括设置类的基本信息、方法的参数及返回值等,提高代码规范性和开发效率。

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

一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释)

1、File-->settings-->Editor-->File and Code Templates-->Files

我们选择Class文件(当然你要设置接口的还也可以选择Interface文件)

(1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名

(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述

(3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}

(4)1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了

2、效果图展示

二、设置方法注释模板

IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是

/**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释

1、File-->Settings-->Editor-->Live Templates

(1)新建组:命名为userDefine

(2)新建模板:命名为*

因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为

/*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、

获取方法返回值的methodReturnType()

(3)设置生成注释的快捷键

(4)设置模板:模板内容如下

注意第一行,只有一个*而不是/*

在设置参数名时必须用${参数名}$的方式,否则第五步中读取不到你设置的参数名

 

*
 * @Author chengpunan
 * @Description //TODO $end$
 * @Date $time$ $date$
 * @Param $param$
 * @return $return$
 **/

如果使用/*生成的模板注释将会是如下效果:所以我们要去掉最前面的/*

(5)设置参数的获取方式

选择右侧的Edit variables按钮

选择每个参数对应的获取方法(在下拉选择框中选择即可),网上有很多教程说获取param时使用脚本的方式,我试过使用脚本

的方式不仅麻烦而且只能在方法内部使用注释时才能获取到参数

(6)设置模板的应用场景

点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere-->Java即可

(如果曾经修改过,则显示为change而不是define)

(7)效果图

创建方法,在方法上面写:/*+模板名+Enter-->/**+Enter

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 就会基于你的模板生成注释了。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值