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

目录
  • 一、概述
  • 二、类注释模板
    • 1、File-->settings-->Editor-->File and Code Templates-->Files
  • 三、方法注释模板
    • 1、创建模板
    • 2、设置模板内容-IDEA格式模板
    • 3、设置模板应用场景
    • 4、设置参数
    • 5、JavaDoc格式
  • 总结

一、概述

IDEA自带的注释模板一般都很简单,然而我们在写代码的时候喜欢把类注释和文档注释写在代码里,既方便自己看所有的参数,也便于以后维护代码的时候看到编码作者。下面是我的代码注释,我们就按照这种格式来设置:

类注释模板:

方法注释模板:

二、类注释模板

1、File-->settings-->Editor-->File and Code Templates-->Files

(1)@BelongsProject:当前项目的名称

(2)@BelongsPackage:当前包的名称

(3)@Author:作者姓名(可以写死,写成你的名字)

(4)@CreateTime:该类创建的时间

(5)@Description:对该类的描述(该类的功能)

(6)@Version:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了

/**
*@BelongsProject: ${PROJECT_NAME}
*@BelongsPackage: ${PACKAGE_NAME}
*@Author: yanhongwei
*@CreateTime: ${YEAR}-${MONTH}-${DAY}  ${HOUR}:${MINUTE}
*@Description: TODO
*@Version: 1.0
*/

三、方法注释模板

1、创建模板

IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,我们的习惯是 /**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释

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

(1)新建组:命名为userDefine

(2)新建模板:选中你刚才创建的组,然后右上角新建模板,命名为*

因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为: /*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType()

2、设置模板内容-IDEA格式模板

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

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

注意:下面这段是代码,可以直接复制的!可以直接复制的!可以直接复制的!不要再问我为什么都是图片了,留着眼睛干啥?

*
 * @description:
 * @author: yanhongwei
 * @date: $date$ $time$
 * @param: $param$
 * @return: $return$
 **/

3、设置模板应用场景

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

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

4、设置参数

把右侧的Expand with:改为Enter ;然后选择右侧的Edit variables按钮

PS:第4步和第5步顺序不可颠倒,否则第5步将获取不到方法

1、IDEA格式的模板只需要为每个参数选择对应的方法即可

2、设置成功后点击OK,返回项目新建一个方法,写完入参和返回值以后,在方法上面:

敲出:/** 回车

5、JavaDoc格式

该格式和IDEA格式略有不同:(@param      @return)

(1)返回上面第二步中的格式设置:输入下面代码(注意格式)

*
 * @description:
 * @author: yanhongwei
 * @date: $date$ $time$ $param$ $return$
 **/

(2)参数设置(JavaDoc格式的需要自定义参数以及返回值的实现方式)

获取参数实现方式:

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

返回值实现方式:

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return: ' + \"${_1}\"", methodReturnType())

如果返回值不想有报名,可以使用下面这个参数:

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').toList();  for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ;  };  return result", methodReturnType())

(3)设置成功后点击OK,返回项目新建一个方法,写完入参和返回值以后,在方法上面:

敲出:/** 回车

然后会显示:(注意不一样的地方)

大家可以根据自己的爱好和风格去设置!!!

总结

到此这篇关于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自定义方法注释模板的教程详解(去param括号、return全类名)

    一.自定义方法模板 1. File >> Settings- >> Editor >> Live Templates 2. 点击创建Group,随意起名 3. 创建模板 4. 填写模板信息 按自己习惯写,我的: * * 方法描述 * @since: 1.14.1 * @param: $params$ * @return: $returns$ * @author: zhang * @date: $date$ */ 5. 设置 设置模板参数自动取值 直接下拉选择 点击下方黄

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

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

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

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

  • 集成开发环境Pycharm的安装及模板设置图文教程

    目录 集成开发环境Pycharm的安装 一.Pycharm的下载及安装 二.pycharm的使用 三.Pycharm模板的设设置 集成开发环境Pycharm的安装 一.Pycharm的下载及安装 jetbrains官网:https://www.jetbrains.com.cn/ PyCharm官方下载网址:https://www.jetbrains.com.cn/pycharm/ PyCharm是一种Python的集成开发环境,带有一整套可以帮助用户在使用Python语言开发时提高效率的工具.

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

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

  • Zend studio文件注释模板设置方法

    步骤:Window -> PHP -> Editor -> Templates,这里可以设置(增.删.改.导入等)管理你的模板.新建文件注释.函数注释.代码块等模板的实例 新建模板,分别输入Name.Description.Pattern a)文件注释 Name: 3cfileDescription: tkyouxi.com文件注释模板 Pattern:/*** tkyouxi.com xx文件* =============================================

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

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

  • Vue.js项目模板搭建图文教程

    前言 从今年(2017年)年初起,我们团队开始引入「Vue.js」开发移动端的产品.作为团队的领头人,我的首要任务就是设计 整体的架构 .一个良好的架构必定是具备丰富的开发经验后才能搭建出来的.虽然我有多年的前端开发经验,但就「Vue.js」来说,仍然是个新手.所幸「Vue.js」有一个配套工具「Vue-CLI」,它提供了一些比较成熟的项目模板,很大程度上降低了上手的难度.然而,很多具体的问题还是要自己思考和解决的. 项目划分 我们公司的H5产品大部分是嵌套在手机客户端里面的页面.每个项目的功能

  • Centos7下oracle12c的安装与配置图文教程(详细)

    一.硬件配置 CentOS7@VMware® Workstation 15 Pro,分配资源:CPU:2颗,内存:4GB,硬盘空间:30GB 二.软件准备 linux.x64_11gR2_database_1of2.zip linux.x64_11gR2_database_2of2.zip SecureCRT 三.虚拟机的配置 挂载镜像,配置本地yum源 /etc/yum.repos.d 设置network.service(配ip) /etc/sysconfig/network-scripts/

  • Android Studio 1.2版安装设置图文教程

    这两天Google更新了Android Studio 1.2正式版,新版本的设置界面大变面,设置条目较旧版本进行了归类,不像以前那样列表长长的了. 趁着安装新版本的机会,把常用的设置记录一下,放到博客里面,以作备忘. 下载 正式版的Android Studio和SDK可以在下面的链接进行下载 http://developer.android.com/sdk/index.html 关于下载,我建议下载绿色版的Android Studio和SDK,别下安装包版捆绑版的,这样如果有哪个出了问题要重装,

随机推荐