javaDoc

 

 

IDEA自定义JavaDOC注释模板

JavaDOC注释模板共分为两种:

  1. 类注释模板
  2. 方法注释模板

方法注释模板

1、创建模板

File–>Settings–>Editor–>Live Templates

点击 “+” 号,选择 “Template Group” 新建组。然后填写自己定义的组名称,点击“OK”。如下图所示:

在这里插入图片描述

选中新建的组,再点击 “+” ,新建"Live Template"。然后填写信息。如下图所示:

注意点:

  1. Abbreviation填写 *
  2. Expand with 快捷键设置为 Enter

在这里插入图片描述

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

注意:如果您的Abbreviation设置为如上图所示的*,template模板如下面所示:

* * @description TODO the method is used to * @author 阿凡达 * @date $time$ $date$ $param$ $return$ */
 
  • 1
  • 2
  • 3
  • 4
  • 5

3、Define

点击Define按钮(如果是修改则点击change

在这里插入图片描述

弹出的对话框中选择java

在这里插入图片描述

4、Edit Variables

注意:必须先进行第三步,再进行第四步
在这里插入图片描述

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())
 
  • 1

返回值实现方式:

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

如下图:

在这里插入图片描述
效果图如下:

在这里插入图片描述

 

__EOF__

本文作者fanfan
本文链接https://www.cnblogs.com/fanwenyan/p/18409887.html
关于博主:评论和私信会在第一时间回复。或者直接私信我。
版权声明:本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!
声援博主:如果您觉得文章对您有帮助,可以点击文章右下角推荐一下。您的鼓励是博主的最大动力!
posted @   MaskerFan  阅读(58)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· DeepSeek “源神”启动!「GitHub 热点速览」
· 微软正式发布.NET 10 Preview 1:开启下一代开发框架新篇章
· C# 集成 DeepSeek 模型实现 AI 私有化(本地部署与 API 调用教程)
· DeepSeek R1 简明指南:架构、训练、本地部署及硬件要求
· NetPad:一个.NET开源、跨平台的C#编辑器
点击右上角即可分享
微信分享提示