基于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的类注释和方法注释操作就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持我们。

时间: 2020-09-15

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

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

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修改新建文件自动生成注释的user名

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

实现core文件自动生成配置文件的方法

本文讲述了实现core文件自动生成的配置方法,具体执行步骤如下: 1.编辑环境配置文件,让shell启动时自动设置ulimit vi /etc/profile ulimit -c unlimited > /dev/null 2>&1 2.更改core文件生成路径 vi /etc/sysctl.conf kernel.core_uses_pid = 1 kernel.core_pattern=/tmp/core-%e-%p 3.sysctl配置生效 sysctl -p /etc/sysc

php新建文件自动编号的思路与实现

要求:在系统中 在新建文件是可以实现自动编号.比如新建文本文件 默认文件名是:新建 文本文档.txt,如果继续新建时文件名自动变了:新建 文本文档 (2).txt, 以后就是 3,4,5-.请问这种算法用PHP怎么实现. 思路,原来想用循环来做,后来想想,用计数器递增吧,简单高效,这个TME可以是数据库,可以文件,可以是配置文件,看你怎么做了,循环只是在维护的时候使用的,如果每建一个新文件也得循环一次,那得累死,缓存无处不在 复制代码 代码如下: <?php $dir="/web/csp/

Eclipse中自动添加注释(两种)

方法一:Eclipse中设置在创建新类时自动生成注释 windows-->preference Java-->Code Style-->Code Templates code-->new Java files 编辑它 ${filecomment} ${package_declaration} /** * @Author fufu * @Time ${date} ${time} * @Version 1.0 * <p>Description:</p> */ $

为nuxt项目写一个面包屑cli工具实现自动生成页面与面包屑配置

公司项目的面包屑导航是使用 element 的面包屑组件,配合一份 json 配置文件来实现的,每次写新页面都需要去写 json 配置,非常麻烦,所以写一个面包屑cli,自动生成页面.自动配置面包屑数据,提高效率:rocket: 明确目标 提供 init 命令,在一个新项目中能够通过初始化生成面包屑相关文件 能够通过命令生成页面,并且自动配置面包屑 json 数据 按照项目原有需求,能够配置面包屑是否可点击跳转 按照项目原有需求,能够配置某路径下是否展示面包屑 支持仅配置而不生成文件,能够为已存

Android中实现自动生成布局View的初始化代码方法

在android开发过程中,界面布局是及其重要的,但同时也是复杂.有的时候我们急于实际运行查看布局效果.但是android的编译速度我实在不想吐槽啥,尤其在布局越来越复杂,项目越来越大,资源文件越来越多的情况下. 尤其是是android的view的初始化,findViewbyId 完全是体力活,我们完全可以根据布局文件自动生成View的初始化代码. 首先声明:   1.这是及其容易做到的,实用性性一般,但是在复杂布局和首次写初始化View代码的时候及其好用. 2.只能生成有id标签的view的初

iOS Xcode创建文件时自动生成的注释方法

之前换了电脑,发现用xcode新建文件生成的注释变成了我不想要的效果(如下图) 一.修改系统默认注释 下面分别描述一下"创建者"."创建时间"."机构名称"以及"类名前缀"如何编辑. 1.编辑创建者: 进入路径:系统偏好设置/用户与群组/右击当前用户进入"高级选项" 编辑"全名"为需要的名称,如图: 2.编辑"创建时间"格式: 进入路径:系统偏好设置/日期与时间/打开

IntelliJ IDEA下自动生成Hibernate映射文件以及实体类

1.构建项目并添加项目结构配置以及配置初始参数 1.1.如图将基本的架子搭建好 1.2.点击File,弹出的菜单中点击Project Structure: 1.3.点击左侧的Modules,再点击"+"号,再在弹出的菜单中选择Hibernate: 1.4.在这时,项目中多出了一个Hibernate,点击Hibernate,再点击"+"号,选择hibernate.hbm.xml: 1.5.弹出的窗口中选择Hibernate的版本,然后点击OK: 1.6.点击OK后在原

使用Mybatis Generator结合Ant脚本快速自动生成Model、Mapper等文件的方法

MyBatis简介: MyBatis是一个支持普通SQL查询,存储过程和高级映射的优秀持久层框架.MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及对结果集的检索封装.MyBatis可以使用简单的XML或注解用于配置和原始映射,将接口和Java的POJO(Plain Old Java Objects,普通的Java对象)映射成数据库中的记录. 相关阅读:MyBatis入门学习教程(一)-MyBatis快速入门 使用过Mybatis的同学都知道,针对每一个项目中使用到的数据库表都需要建

VSCode中自动为Python文件添加头部注释

在实际编写Python文件时,往往需要为文件添加相关说明,例如文件名称.文件作用.创建时间.作者信息.版本号等等.这些信息往往是固定模板的,因此希望有一种方式可以自动的为我们添加上这些信息.下面介绍一种在VS Code中自动为python文件添加头部注释的方法. 依次单击菜单栏 "File"-"Preferences"-"User Snippets",然后选择python后会生成python.json文件,将该文件内容替换为以下内容: { &qu