基于IntelliJ IDEA的类注释和方法注释操作

效果图如下：

类注释：

方法注释：

idea不会默认帮我们设置，所以需要手动设置。

1：IDEA中在创建类时会自动给添加注释

打开idea,操作

File–>settings–>Editor–>File and Code Templates–>Files

（1）NAME：设置类名，与下面的NAME：设置类名，与下面的{NAME}一样才能获取到创建的类名

（2）TODO：代办事项的标记，一般生成类或方法都需要添加描述

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

2.在方法的上面一行输入/*然后回车，就有方法的注释设置如下

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

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

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

（1）新建组：命名为userDefine

（2）选中userDefine在其目录下新建模板：命名为*

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

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

（3）设置生成注释的快捷键

（4）设置模板：模板内容如下

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

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

*
* @Author 小思
* @Description //TODO
* @Date $time$ $date$
* @Param $param$
* @return $return$
**/

（5）设置模板的应用场景

点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择EveryWhere–>Java即可（如果曾经修改过，则显示为change而不是define）

（6）设置参数的获取方式

依次下拉选择即可。

注意第五步和第六步的顺序不可颠倒哦~

以上这篇基于IntelliJ IDEA的类注释和方法注释操作就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持我们。

赞 (0)

相关推荐

  • eclipse/intellij idea 查看java源码和注释方法

    工作三年了,一直不知道怎么用IDE查看第三方jar包的源码和注释,惭愧啊!看源码还好些,itellij idea自带反编译器,eclipse装个插件即可,看注释就麻烦了,总不能去找api文档吧!现在终于掌握了,下面给出解决方案,供大家参考,以提升开发学习效率! eclipse 1.下载源码包 1.1 去官网下载 1.2 去maven仓库下载( 例如:maven mysql 百度一下,肯定会出现仓库地址,找某一个版本下载即可) 1.3 maven命令下载(适用maven项目),在pom.xml文件

  • Intellij IDEA如何自定义注释模板的实现方法

    想栈长我当初从 Eclipse 转用 IDEA 真是纠结,放弃然后尝试了N次,不过现在已经算是转型成功了,可以完全脱离 Eclipse 撸码了,虽然说我现在真的撸得非常少了.. 说到 IDEA 的痛点,我觉得注释配置就不是很人性化.Eclipse 可以很方便的设置和导入公共的自定义注释模板.格式化模板,但在 IDEA 中确实有点蹩脚,配置起来甚至有点高级,还需要用到 Grovvy 脚本.. 废话不说了,来看下如何解决 Intellij IDEA 最头大的问题:自定义注释模板.. IDEA 中有以

  • IntelliJ IDEA修改新建文件自动生成注释的user名

    IntelliJ IDEA修改新建文件自动生成注释的user名

    想要在IntelliJ IDEA编辑器里面修改,新建Class文件或者jsp文件或者js文件时候 文件头自带的 Created by {User} on ${DATE}. 一般在新建的时候,user默认取的是电脑的主机名,这个不是我们想要的.可以如下图修改. 如果还有什么类型,没提到的,自己找找自己要用的就可以啦.一个道理. 说明一下: 可以分别点击class,interface,enum,等等,可以看到右边的编辑框里面都有一个#parse("file header.java") 这个

  • 基于IntelliJ IDEA的类注释和方法注释操作

    效果图如下: 类注释: 方法注释: idea不会默认帮我们设置,所以需要手动设置. 1:IDEA中在创建类时会自动给添加注释 打开idea,操作 File–>settings–>Editor–>File and Code Templates–>Files (1)NAME:设置类名,与下面的NAME:设置类名,与下面的{NAME}一样才能获取到创建的类名 (2)TODO:代办事项的标记,一般生成类或方法都需要添加描述 (3)USER.USER.{DATE}.TIME:设置创建类的用户

  • 详细介绍idea如何设置类头注释和方法注释(图文)

    详细介绍idea如何设置类头注释和方法注释(图文)

    intellj idea的强大之处就不多说了,相信每个用过它的人都会体会到,但是我们也会被他的复杂搞的晕头转向,尤其刚从eclipse转过来的童鞋,相信刚开始的那段经历都是不堪回首的,我也是一步步这么走过来的. 今天讲的一个主题是如何实现类似eclipse的Code Templates那样的功能,进行文件级别的方法级别注释的实现. idea和eclipse的注释还是有一些差别的. idea: 类头注释:打开file->setting->Editor->Filr and Code Temp

  • 基于IntelliJ IDEA运行慢的解决方法

    今天在用IntelliJ IDEA运行项目时速度奇慢,上网找了一些解决方法,记录一下以供参考. 修改配置文件 IntelliJ IDEA\bin下idea.exe.vmoptions -server -Xverify:none -Xms300M -Xmx512M -XX:+UseParNewGC -XX:PermSize=128m -ea -server 使用server jvm.酌情使用,有些doc说IDEA加该选项可以提高速度. -Xverify:none 关闭Java字节码验证,从而加快了

  • idea生成类注释和方法注释的正确方法(推荐)

    最近从eclipse转idea了,第一步当然是配置快捷键,模板等.但是!发生了一件贼蛋疼的事情,竟然一直找不到正确添加方法注释的方法! 最后自己摸索到了,在此详细记录,供大家参考. 测试版本为idea for mac,可能快捷键不同,但是设置等肯定是相同的 生成类注释 打开Preferences Editor -> File and Code Templates -> Files -> Class 3.效果图 网上很多都是在Includes的File Header里面添加,在这里面添加还

  • idea 自动生成类注释和方法注释的实现步骤

    换电脑重新安装了idea,记录下添加自动注释的方法,以备后续使用 idea版本:2018.3.1 1. 生成类注释 打开setting -> Editor -> File and Code Templates -> Files -> Class 生成类注解模板 /** * @program: ${PROJECT_NAME} * @description: ${description} * @author ${USER} * @date ${YEAR}-${MONTH}-${DAY}

  • 基于Intellij Idea乱码的解决方法

    使用Intellij Idea经常遇到的三种乱码问题: 1.工程代码乱码 2.main方法运行,控制台乱码 3.tomcat运行,控制台乱码 解决方案: 1.工程代码乱码 Settings > Editor > File Encodings > Global Encodings & Project Encodings 设置为:UTF-8 2.main方法运行,控制台乱码 Settings > Build, Execution, Deployment > Compile

  • VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)

    如何设置一个自定义注释 整洁的代码和注释风格总是给人一种眼前一亮.赏心悦目的感觉,同时详细的注释也是程序员所必须的职业素养之一 今天主要分享一下如何在VS Code中设置自定义 注释 第一步: 使用ctrl + shift + p 调出如下窗口,并且输入snippets 第二步:进入json文件编辑 这里以自定义js注释为例: 进入到 json 文件中后,添加如下代码,大家可以自定义设计,保存退出 我这里是一个类注释 一个方法注释 "Print to js class": { &quo

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

    idea 模版之自定义类与方法注释 很多公司都有要求的代码注释规范,我们每新建类或者方法的时候从新复制粘贴很麻烦,而且容易粘错. 当然自定义模板还可以用到很多地方,比如系统自带的 sout就是system.out.print(); 当你输入某文本的时候,系统会自动替换成目标文本. 1定义java文件头部的注释 2给java类中的方法添加上注释 2.1第一步勾选Enable Live  Templates 2.2第二步新建一个Group 2.3第三步新建一个Template 2.4第四步点击Def

  • PHP基于单例模式编写PDO类的方法

    一.单例模式简介 简单的说,一个对象(在学习设计模式之前,需要比较了解面向对象思想)只负责一个特定的任务: 二.为什么要使用PHP单例模式? 1.php的应用主要在于数据库应用, 所以一个应用中会存在大量的数据库操作, 使用单例模式, 则可以避免大量的new 操作消耗的资源. 2.如果系统中需要有一个类来全局控制某些配置信息, 那么使用单例模式可以很方便的实现. 这个可以参看ZF的FrontController部分. 3.在一次页面请求中, 便于进行调试, 因为所有的代码(例如数据库操作类db)

随机推荐