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

最近从eclipse转idea了，第一步当然是配置快捷键，模板等。但是！发生了一件贼蛋疼的事情，竟然一直找不到正确添加方法注释的方法！ 最后自己摸索到了，在此详细记录，供大家参考。

测试版本为idea for mac，可能快捷键不同，但是设置等肯定是相同的

生成类注释

  1. 打开Preferences
  2. Editor -> File and Code Templates -> Files -> Class

3.效果图

网上很多都是在Includes的File Header里面添加，在这里面添加还需要自己去移动下鼠标，然后再去操作键盘，再去写description，，直接在创建类的时候就添加好description不更快吗？

1.在此添加的话你每次创建类的时候会弹两次框，第二次是让你输入description的内容了，so, 这就是最优的方法

4.同理，也可以在这儿为你的Interface，Enum添加上注释

生成类注解模板

/**
* @program: ${PROJECT_NAME}
*
* @description: ${description}
*
* @author: Mr.Wang
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

这里的代码区显示有问题，csdn有bug ，去掉里面的中文就行了。

生成方法注释

  1. 打开Preferences
  2. Editor -> Live Templates -> 点击右边加号为自己添加一个Templates Group -> 然后选中自己的Group再次点击加号添加Live Templates


3.然后设置自己喜欢的快捷键 在Abbreviation里面 记得在Applicable in 里面勾选,起码也要勾选class

4.然后在Edit variables里面添加参数和返回值的自动取值

Expression里面选择就是了

5.然后再你的方法上面直接输入/ + 你设置的Abbreviation快捷键 + tab键就直接生成了 （我设置的是/+ a + tab）
效果图：

里面的参数和返回值都是根据你在Edit variables里面添加的自动生成的，

生成方法注解模板

**
* @Description: $description$
* @Param: $params$
* @return: $returns$
* @Author: Mr.Wang
* @Date: $date$
*/

注意，这个和类注解模板有点不一样，这个是用两个$$ ，这个的作用就是生成后光标直接跳到当前位置，这样也可以直接去输入description的内容了

对于 Live Templates只能说真的很强大，你平常用的sout ,psvm什么都是里面的，大家可以自行百度一下学习一下。

到此这篇关于idea生成类注释和方法注释的正确方法的文章就介绍到这了,更多相关idea生成类注释和方法注释内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

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

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

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

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

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

  • 基于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添加Java类注释模版的方法

    IDEA添加Java类注释模版的方法

    本文介绍了IDEA添加Java类注释模版的方法,分享给大家,具体如下: IDEA版本:IntelliJ IDEA 2017.2.5 x64 eclipse能在类上方输入/**,回车添加类注释模版,但idea没有默认添加这个功能,需要做一些设置.下面介绍三种方法实现: 创建类默认添加类注释 手动添加类注释 批量添加JavaDoc注释 一.设置新建类默认添加注释 依次点击Setting|Editor|File and code templates,添加如图配置 例子: /** *describe:

  • 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}

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

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

  • Android Studio自定义万能注释模板与创建类,方法注释模板操作

    代码的注释是我们平时必须面对的问题,今天我们就来看看如何自定义属于自己的注释模板.提高我们的开发效率. 这里,我们讲解两种自定义模板. 1.新建的类自动生成的注释: 2.自定义注释模板. 新建类自动生成的注释 1.打开相应的设置: File–>Settings–>Editor–>File and code Template. 选择Files中的Class 在上面添加你想要添加的注释: 下面有一些变量可以选择: {USER} :表示你系统名字: {DATE}: 表示当前时间: {NAME}

  • IDEA类与方法注释模板设置图文教程(非常详细)

    IDEA类与方法注释模板设置图文教程(非常详细)

    目录 一.概述 二.类注释模板 1.File-->settings-->Editor-->File and Code Templates-->Files 三.方法注释模板 1.创建模板 2.设置模板内容-IDEA格式模板 3.设置模板应用场景 4.设置参数 5.JavaDoc格式 总结 一.概述 IDEA自带的注释模板一般都很简单,然而我们在写代码的时候喜欢把类注释和文档注释写在代码里,既方便自己看所有的参数,也便于以后维护代码的时候看到编码作者.下面是我的代码注释,我们就按照这种

  • IDEA2020.3.2版本自动注释类和方法注释模板配置步骤详解

    IDEA2020.3.2版本自动注释类和方法注释模板配置步骤详解

    想来大家在学习或者开发的环境下经常要自己注解类和方法吧:下面我来为大家讲解怎么创建自己的注解模板: 一.配置类自动注解 1.打开idea file–>Settings–> 2.按照下图的步骤:直接搜索file and code–>导航栏点击File and Code Templates–>点击files文件类型–>然后选择Class文件模板在里面编辑自己想要的模板–>点击apply应用一下–>点击ok.如果还要设置方法模板的话先别急着点ok. 类注解代码片:根据自

  • Python类和方法注释规范说明

    Python类和方法注释规范说明

    目录 Python类和方法注释规范 注释风格 小技巧 代码规范(含代码注释) 代码缩进和冒号 空行分隔代码段 包.模块的命名规范 类和对象的命名规范 函数的命名规范 代码注释 Python类和方法注释规范 注释风格 reStructuredText(PyCharm默认) def func(path, field_storage, temporary): '''基本描述 详细描述 :param path: The path of the file to wrap :type path: str :

  • pycharm自动生成文件注释和函数注释

    pycharm自动生成文件注释和函数注释

    1. 文件注释 File -> settings -> Editor -> File and Code Templates -> Python Script pycharm提供了一个在新建文件自动生成文件头注释的功能,可以实现自动生成运行环境,作者.日期等必要信息,使用比较方便,配置十分简单. 按照1-5的路径选项即可.在5中填写想要的注释. 我的模板: # -*- encoding: utf-8 -*- ''' @File : ${NAME}.py @Contact : emac

随机推荐