idea 行注释（首行设置）

已于 2023-05-14 21:24:44 修改
阅读量1.2k 收藏 1
点赞数 1
分类专栏： 工具 文章标签： intellij-idea java ide
于 2018-12-19 10:15:54 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/guochan_xl/article/details/85089718
版权

idea版本：

iIntelliJ IDEA 2018.1.6 (Ultimate Edition)

具体设置：

注意改默认设置（Default Settings），而不是设置(Settings)。
注释

设置完毕效果：

在这里插入图片描述

【IDEA】IDEA配置类、方法注释模板
baidu_21035953的博客
07-16 6921
打开 IDEA 的Settings，点击，点击右边File选项卡，在下面找到的Class，将注释模板配置到图中红框内后，点击Apply按钮，而后点击OK按钮，即可完成类注释配置本文提供的示例模板中，说明了类名称、作者、时间和类描述，IDEA 支持的所有的模板参数在下方的 Description中被列出，如下图保存后，当你创建一个新的类的时候就会自动添加类注释。如果你想对接口也生效，按照上述配置，配置Files选项卡中的Interface项即可。
IntelliJ IDEA 注释模板，参数分行，完美设置
weixin_39858705的博客
04-12 3060
** * @Description: * $description$ * @Author: 你的名字 * @Date: $date$ $time$ $params$ * @return: $returns$ */
IDEA设置注释
fen_fen的专栏
09-07 431
IDEA设置注释
IDEA注释在首行问题
仗剑天涯
02-16 495
解决IDEA快速注释总是出现在首行位置
idea中快速注释函数
最新发布
weixin_42220130的博客
03-24 832
如果你想自定义注释的格式，可以通过以下步骤设置自定义的Live Template[4打开系统设置（Setting），使用快捷键Ctrl+Alt+S。在设置窗口中，导航到Editor->。点击号，添加一个新的模板组来放置自定义的快捷键模板。选中创建的组，再次点击号，添加一个新的Live Template。设置自定义的快捷键模板，包括Abbreviation（快捷键）、Description（描述）、Template text（自定义模板内容）。
IDEA设置单行注释符在代码行首部
CodeRain的博客
11-22 1330
需求 默认 IntelliJ IDEA 对于 Java 代码的单行注释是把注释的斜杠放在行数的最开头，个人觉得看着不舒服，所以设置为单行注释的两个斜杠跟随在代码的头部 解决方案 注： 1：斜杠显示在代码行首。 2：斜杠显示在整行的最前端 设置为1的效果如下： ...
idea设置单行注释符在代码行首部
m0_57133702的博客
09-22 1235
默认 IntelliJ IDEA 对于 Java 代码的单行注释是把注释的斜杠放在行数的最开头，个人觉得看着不舒服，所以设置为单行注释的两个斜杠跟随在代码的头部 设置如下（idea版本：2021.1.2 x 64）： 注：1：斜杠显示在代码行首。2：斜杠显示在整行的最前端 设置为1的效果如下： ...
Idea 注释-取消行首注释
秋冬梦呓
03-23 838
当注释符出现在行首时，会对整体页面的可读性产生不良影响，使代码难以阅读和理解。File–>setting–>editor–>code style(找不到可以搜索)–>java。Block comment at first column(在第一列阻止注释)找到 Comment Code ，将（如图中红色箭头所指向得两个复选框去掉）Line comment at first column(行注释在第一列)将（复选框勾上 // 会在 补一个space，更加美观一些）在默认配置的IDEA中注释默认行首。
史上最全的IDEA快捷键总结
08-25
史上最全的IDEA快捷键总结 IDEA 作为一款功能强大且广泛使用的集成开发环境（Integrated Development Environment），提供了大量的快捷键来提高开发效率。下面将对 IDEA 的快捷键进行分类总结，並对每个快捷键进行...
在IntelliJ IDEA的IDE，为类自动配置上公司的Copyright信息及配置项目和IDEA全局设置
阿啄debugIT
06-17 2663
前言 IntelliJ IDEA是Java语言开发的集成环境，IntelliJ在业界被公认为优秀的Java开发工具之一，尤其在智能代码助手、代码自动提示、重构、J2EE支持、Ant、JUnit、CVS整合、代码审查、 创新的GUI设计等方面的功能可以说是超常的。 配置 1、Copyright信息？ 用来添加文件时说明版权归属。 2、配置 选择File->Settings->Appearance & behavior -> Scopes （1）新增一个scope，设置
IDEA编译器的高效使用
Rickie_7的博客
10-28 563
参考1：https://blog.youkuaiyun.com/weixin_42132763/article/details/95609123#_57 参考2：https://blog.youkuaiyun.com/ysj4428/article/details/82220007 1 添加注释 1.1 方法或类注释： 在一个方法或类的开头，输入/**，然后按回车,自动根据参数和返回值生成注释模板，我们在这个模板上面编写即可。 1.2 行注释Ctrl+/ 首先你的光标要处于这一行，处于这行的哪个位置都可以,按Ctr
【IDEA】快捷键注释位置不放置在首行，放置在当前行第一个字符攻略
程序员小王的博客
10-26 4406
【IDEA】快捷键注释位置不放置在首行，放置在当前行第一个字符攻略 ???? Java学习路线：搬砖工的Java学习路线 ???? 作者：程序员小王 ???? 程序员小王的博客：https://www.wolai.com/wnaghengjie/ahNwvAUPG2Hb1Sy7Z8waaF ???? 扫描主页左侧二维码，加我微信 一起学习、一起进步 ???? 欢迎点赞 ???? 收藏 ⭐留言 ???? IDEA可以很方便的使用Ctrl+/来进行注释和反注释。 但是注释符号的位置默认是在每一行的第一个字符。因
IDEA快捷注释代码//设置不在行首
让梦想疯狂
03-27 1187
IDEA快捷注释代码//取消设置在行首
解决idea注释自动在行首的问题
qq_45649806的博客
12-24 1578
Idea 行注释设置（不显示在行首）
热门推荐
点点滴滴
01-06 1万+
进入 Settings -> Code Style -> Java ，在右边选择 “Code Generation” Tab，然后找到 Comment Code 那块，把 Line comment at first column Block comment at first column 去掉前面两个的复选框
IDEA中注释代码，注释符如何不显示在行首
脑壳疼
10-11 2514
1. 打开idea编辑器后，注释代码，会发现注释符在行首，导致版面很难看 2. 点击File->Settings，如图所示 3. 在弹出的窗口中左侧栏的搜索框中输入code style进行搜索，找到java 4.点击步骤3中的java项后，在有测面板中找到如图所示的标签页 5. 取消勾选如图所示的选项 6. ...
IDEA 注释对齐
别忘了微笑
08-22 585
[(16条消息) idea单行注释与代码对齐_fgx_123456的博客-优快云博客_idea 注释对齐](https://blog.youkuaiyun.com/fgx_123456/article/details/85599643)
idea中设置代码注释（多个参数分行显示、参数字段不对齐问题解决）
weixin_42684368的博客
07-21 2043
详解介绍idea中设置注释模板的教程，解决参数分行不显示、参数字段不对齐等问题
IDEA类和方法注释模板设置（非常详细）
2303_77877769的博客
05-04 2464
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。深知大多数Java工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。
idea配置方法注释模版有方法返回值
03-20
<think>好的，我现在需要解决用户在IntelliJ IDEA中配置方法注释模板，使其包含返回值的问题。首先，用户提到之前尝试过设置groovyScript脚本但未成功，引用中的资料显示模板格式错误可能是原因。我需要参考提供的引用内容，特别是引用[2]和[4]，看看正确的步骤是怎样的。 根据引用[2]，用户需要在Live Templates中新建模板组，比如Method Comment，然后创建模板。关键点在于参数的表达式设置，比如使用groovyScript来获取参数和返回值。可能需要检查变量的表达式是否正确，尤其是返回值的处理。引用[3]提到预定义变量，这可能涉及$VAR$之类的占位符。 用户可能遇到的问题包括模板位置错误，比如将模板放在方法体内还是体外。引用[2]指出，放在方法体内才能正确获取参数和返回值，因此需要确保模板的位置正确。此外，变量的作用范围也需要设置，比如在Edit Variables中为每个参数选择正确的表达式，例如使用groovyScript("...")来解析参数列表和返回值类型。 可能还需要指导用户如何编辑模板的缩写，比如使用*来触发，并关联到Java上下文。最后，测试模板是否能正确生成包含返回值的注释，确保没有语法错误。需要将这些步骤详细列出，确保用户能够逐步操作，并解决常见问题如参数为空的情况。</think>### 如何在IntelliJ IDEA中配置方法注释模板以包含返回值 #### 步骤说明 1. **打开实时模板设置** 依次点击：`File` → `Settings` → `Editor` → `Live Templates`，进入模板管理界面[^2][^4]。 2. **新建模板组（可选）** 点击右上角`+`号，选择`Template Group`，输入组名（例如`Method Comment`）以便分类管理。 3. **创建方法注释模板** - 在新建的模板组中，点击`+` → `Live Template`。 - 设置缩写（Abbreviation）：输入触发注释的快捷词，例如`*`。 - 设置描述（Description）：例如“方法注释模板”。 - **模板内容**： ```text * 方法功能: $END$ * @param $PARAMS$ * @return $RETURN$ */ ``` 注意：首行需以`/*`或`/**`开头，且最后一行以`*/`结束。 4. **配置变量表达式** - 点击`Edit variables`按钮，为`PARAMS`和`RETURN`绑定表达式： - **PARAMS**: ```groovy groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result += (i == 0 ? '' : ' ') + ((i < params.size() - 1) ? '* @param ' : '* @param ') + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters()) ``` - **RETURN**: ```groovy groovyScript("def type=\"${_1}\"; return type == 'void' ? '' : type", methodReturnType()) ``` - 勾选`Skip if defined`以避免未定义变量报错[^3]。 5. **设置作用范围** 点击`Define` → 选择`Java` → 确认模板适用于方法上下文。 6. **测试模板效果** 在方法上方输入`/*` + 快捷键（例如`*`），即可生成包含参数和返回值的注释： ```java /** * 方法功能: * @param param1 参数1描述 * @param param2 参数2描述 * @return 返回值描述 */ public String exampleMethod(int param1, String param2) { return "result"; } ``` #### 常见问题解决 - **参数/返回值为空**：确保模板触发位置在方法体内，且表达式语法正确[^2]。 - **无法识别变量**：检查`Edit variables`中的groovyScript表达式是否完整，尤其注意逗号和引号是否转义[^3]。 ---
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值