详细:idea如何设置文件头注释和方法注释

本文介绍如何在IntelliJ IDEA中配置类头和方法注释模板,包括自定义注释格式、参数获取方式及应用场景设置。

idea:

类头注释:打开file->setting->Editor->Filr and Code Templates->Includes->File Header 
这里写图片描述
直接在右边的文件框里编辑你说需要注释的东西,然后应用保存之后,当你创建类的时候就会自动生成注释。

方法注释:打开file->setting->Editor->LiveTemplates点击右边上面那个绿色的+号,选择Template Group双击,然后弹出一个窗口,随便添加一个名字,我这里添加的是MyGroup然后点击OK 
这里写图片描述

还是在file->setting->Editor->LiveTemplates这个路径下点击一下刚刚你添加的那个名字(我这是MyGroup),然后点击右边上面那个绿色的+号,选择LiveTemplate双击,填写下面的图上的框 
这里写图片描述
然后点击这里写图片描述 
然后选择Everywhere 
这里写图片描述

最后点击右下角的Edit variables 按钮,然后弹出一个窗口,如下: 
这里写图片描述
如果想把 @param:每一个参数可以这样 
这里写图片描述
参数值要自己写的

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n\\b' : '')}; return result", methodParameters())
  • 1

把这个添加进去,但是还要注意一点: 
这里写图片描述 
下面红色圈中的下拉框选择相对应的参数点击OK 
再点击apply,点击Ok。 

然后写方法之前点写上add(刚刚填的)按tab,注释就出来了。


第二篇

-------------------------------------------------------------------------------------

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

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

类注释模板:                                                                      方法注释模板:

    

一、首先我们来设置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)设置模板:模板内容如下

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

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

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

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

选择右侧的Edit variables按钮

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

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

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

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

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

(7)效果图

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



<think>首先,用户的问题是关于IDEA方法注释模板。用户说:“我想查找IDEA方法注释模板 请问IDEA方法注释模板”。这表明用户想要了解如何设置或查找IDEA中的方法注释模板。 回顾之前的引用: - 引用[1]:讨论IDEA方法注释模板设置,提到自定义注释模板。 - 引用[2]:详细描述idea注释方法注释模板的设置,包括位置选择、命名、快捷键设定内容设定。特别提到了方法模板的设定,如Template text的内容。 - 引用[3]:类似的内容,但结尾有推广信息。 用户的查询是直接的:“IDEA方法注释模板”,所以我需要提供关于如何设置或使用IDEA方法注释模板的指导。 系统指令: - 使用中文回答。 - 回答结构清晰,帮助用户逐步解决问题。 - 尽量保证回答真实可靠(基于提供的引用)。 - 在引用的段落末尾自然地添加引用标识,如[^1]。 - 所有行内数学表达式用$...$格式(但这里可能不适用,因为主题是IDEA设置,不是数学)。 - 独立公式用$$...$$(同样可能不适用)。 - 最后,生成相关问题。 基于引用[2],它提供了具体的设置步骤: 1. 位置:Preferences -> Live Templates -> 添加用户自定义模板。 2. 命名、描述、快捷键:例如命名为*,描述为"add Commands for method",快捷键设为Enter。 3. 模板内容:Template text内容示例:** * @author YourName * @date $time$ $date$ * @method $name$ * @brief * @Param $param$ * @return $return$ */ 用户可能想要知道如何设置这个模板,所以我应该一步步解释。 结构化回答: 1. **介绍**:简要说明方法注释模板的作用。 2. **设置步骤**: - 打开IDEA设置(Preferences)。 - 导航到Live Templates。 - 添加新模板。 - 配置模板内容。 3. **示例模板**:提供引用中的示例模板。 4. **注意事项**:提到如何定义变量如$param$,$return$等。 引用结尾添加标识:在引用的段落末尾添加[^1],[^2]等。 例如,如果我在回答中引用引用[2]的内容,就在那部分后加[^2]。 生成相关问题:在回答结束后,添加“§§相关问题§§”部分,列出相关问题。 可能的步骤: - 确认需求:用户想要方法注释模板的设置。 - 基于引用提供指导。 回答大纲: 1. 开头:回复用户查询。 2. 详细步骤:参考引用[2]。 - 位置:Preferences -> Live Templates -> Add new template. - 设置模板:名称、描述、快捷键。 - 模板内容:如引用[2]所示。 - 变量设置:例如$param$$return$需要定义,IDEA有内置变量。 3. 示例:展示一个模板示例。 4. 结尾:总结。 5. 生成相关问题。 添加引用标识:在描述设置步骤时,如果直接来自引用,加标识。 例如:"在IDEA设置方法注释模板,可以通过Preferences -> Live Templates -> 添加用户自定义模板来完成[^2]." 最后,添加相关问题。 相关问题想法: 1. 如何自定义类注释模板? 2. 如何让注释模板自动生成参数描述? 3. 分享您的常用方法注释模板示例? 确保回答真实可靠:基于提供的引用,我不会添加额外信息,以免不准确。 完整回答结构: - 介绍部分。 - 设置方法注释模板的步骤。 - 示例模板。 - 结尾。 - §§相关问题§§。 </think>### IDEA方法注释模板设置指南 在IDEA中,方法注释模板用于自动生成方法的JavaDoc风格注释,便于代码维护文档化。设置方法注释模板主要涉及IDEA的Live Templates功能,允许自定义模板内容快捷键。以下基于可靠参考信息,我将一步步引导您完成设置过程。设置前,请确保您使用的是最新版IDEA(如IntelliJ IDEA 2023或更高版本)。 ### 步骤详解 1. **打开设置界面** - 启动IDEA,点击顶部菜单栏的 "File" → "Settings"(Windows/Linux)或 "IntelliJ IDEA" → "Preferences"(macOS)。 - 在设置窗口中,导航到 "Editor" → "Live Templates" [^2]。 2. **创建新模板** - 在Live Templates界面,点击右侧的 "+" 图标,选择 "Template Group" 创建一个新分组(例如命名为 "MyTemplates"),便于管理。 - 然后,在新分组下点击 "+" → "Live Template" 添加方法注释模板。 - **Template name**: 建议设置为 `*`(星号),这样在代码中输入 `/**` + 模板名称(如`*`)可快速触发注释[^2]。 - **Description**: 添加描述信息,例如 "Add method comments for JavaDoc"。 - **Shortcut key**: 推荐设为Enter键,这样输入快捷键后按Enter即可自动生成注释。 3. **配置模板内容** - 在 "Template text" 输入框中,粘贴自定义的注释格式。以下是一个常用示例(基于引用[2]的模板): ``` ** * @author YourName * @date $time$ $date$ * @method $name$ * @brief 方法简要描述 * @Param $param$ * @return $return$ */ ``` - **变量说明**: - `$time$` `$date$`:IDEA内置变量,自动插入当前时间日期[^2]。 - `$name$`:自动填充方法名。 - `$param$`:自动生成方法参数列表(需额外配置变量)。 - `$return$`:自动填充返回值类型。 - 要为 `$param$` `$return$` 添加变量定义,点击 "Edit variables" 按钮: - 对于 `$param$`,选择 "Expression" 为 `methodParameters()`,并勾选 "Skip if defined"。 - 对于 `$return$`,选择 "Expression" 为 `methodReturnType()`。 - 其他变量如 `$date$` 选择 `date()`,`$time$` 选择 `time()`,确保它们自动解析[^2]。 4. **应用范围设置** - 在 "Applicable contexts" 区域,勾选 "Java" → "Declaration",确保模板仅在Java方法声明时生效。 - 点击 "Apply" 或 "OK" 保存设置[^1][^2]。 5. **使用方法** - 在Java代码中,输入 `/**` 后按模板快捷键(如Enter),IDEA会自动生成注释框架。例如: ```java public int add(int a, int b) { return a + b; } ``` 输入 `/**` + Enter 后,注释将生成: ```java ** * @author YourName * @date 15:30 2024-03-28 * @method add * @brief 方法简要描述 * @Param a,b * @return int */ public int add(int a, int b) { return a + b; } ``` ### 注意事项 - **自定义建议**:您可以根据团队规范修改模板,例如添加 `@throws` 或其他标签。引用[1]强调,良好的注释模板能提升代码可读性[^1]。 - **问题排查**:如果模板不生效,检查Applicable contexts是否正确配置,或重启IDEA。 - **最佳实践**:定期备份模板设置(通过File → Export Settings),避免丢失[^3]。 通过以上步骤,您就能高效设置IDEA方法注释模板了。如果您需要进一步优化,参考引用[2]的详细指南或IDEA官方文档会更有帮助。
评论 7
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值