idea java doc 模板_Idea配置Javadoc

方法一：自动生成类注释

在创建类的时候，自动生成类注释，打开Settings>Editor>File and Code Templates，Files页签下，选择Class/Interface，可以看到引用了#parse("File Header.java")模版：

自动生成类注释

所以我们来修改模版即可，Includes页签下，选择File Header模版，右侧即自定义模版，下面的Description中描述了支持的参数：

引用模版修改

配置模版如下：

/**

* @Description TODO

* @author ${USER}

* @date ${DATE}-${TIME}

测试自动生成类注释

方法二：自定义模版生成类(方法)注释

方法一只能在类定义时生成注释，如果想重新定义或给方法生成注释，则需要自定义模版进行配置，打开Settings>Editor>Live Templates，自定义一个模版组，来创建自己的模版：

创建自定义模版组

创建自定义模版

设置类注释及参数：

配置好以下内容后，在类上方输入/*c，按下Enter即可添加类注释：

* $END$

* TODO

* @author $user$

* @date $date$

**/

参数配置：date("yyyy-MM-dd HH:mm:ss")，设置完成后需要按Enter键，否则无法保存。

类注释

设置方法注释及参数：

配置好以下内容后，在类上方输入/*m，按下Enter即可添加方法注释：

* $END$

* TODO

* @author $user$

* @date $date$

$param$

* @return $return$

**/

==开头不能有/，否则param显示错误==；

参数配置:

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

方法注释

方法三：直接替换文件

是不是稍微有点麻烦...我找到了自定义模版存放的路径，文件名称即为模版组名称：

注释模版默认地址

不想手动配置的朋友可以在路径下创建一个XXX.xml文件，将下面的内容复制保存，重启一下Idea就可以直接使用了：

idea java doc 模板_Idea配置Javadoc相关推荐

idea java doc 模板_IntelliJ IDEA 符合 JavaDOC 的注释模板设置方法
类注释模板: /*** @version 0.1.0** @author your name or email** @since 0.1.0** @create ${YEAR}-${MONTH}-${ ...
idea java 注释模板_idea java 注释模板配置
在网上找了好久,好多的文章都有一个共同的病点就是"@param注释当有多个参数时候,全部放在了一行里面",非常不友好. 以下是我整理好的,完全按照eclipse的注释风格. !!! ...
idea将junit设置模板_IDEA配置JUnit进行单元测试
前提条件安装JDK,并配置好环境变量工程已解决JUnit依赖关系(pom.xml) IDEA中JUnit配置 IDEA自带一个JUnit插件,打开Settings窗口搜索junit,如图: 图 1 ...
idea java svn 设置_idea配置svn，随时拉取和上传代码的正确做法
SVN在企业大型项目中,团队协作发挥的作用是非常巨大的.特别是很多特殊的项目,管理功能很强大.作为团队开发的一员,必须要完全掌握使用方法,才能高效撸代码. idea版本:2017.3 svn版本:1. ...
easycode 表配置_idea的easyCode的 MybatisPlus模板的配置详解
EasyCode 插件 EasyCode 插件是一款根据表结构生成代码的很方便的Idea插件, 强烈推荐. 并且可以自定义模板来控制生成的类我在使用的过程中发现一些问题,现在把解决办法记录下来, ...
JAVA 根据模板生成doc文件
JAVA 根据模板生成doc文件需求根据模板生成对应的doc文档,文档内容动态填充. 实现 1.将doc模板转换为ftl文件,放入项目中 1.1 首先将模板另存为xml文件 1.2 更改xml文件 ...
怎么配置java环境_idea配置java环境
鄙视楼上复制百度的,在实际应用中很难管用教你个最简单的配置方法,以java安装在c:\programfiles\java为例在环境变量中,path中加入c:\programfiles\java\jdk ...
java 邮件模板_Spring Boot 优雅地发送邮件
最近在项目开发中有向使用者发送报警通知的功能,其中报警媒介就包括邮件,这篇文章就简单介绍了 Spring Boot 如何快速集成实现邮件发送. 通常在实际项目中,也有其他很多地方会用到邮件发送,比如通 ...
java Doc文档生成方式
Java Doc Javadoc命令是用来生产自己API文档的参数信息 @author作者名 @version 版本号 @since 指明需要最早使用的JDK版本 @param参数名 @return ...

idea java doc 模板_Idea配置Javadoc

idea java doc 模板_Idea配置Javadoc相关推荐

最新文章

热门文章