Idea最常用的注释模板，方法级、属性级、类级、类文件级注释_idea 注释模板表达式-程序员宅基地

技术标签： java idea intellij-idea intellij idea

一、方法级注释和属性级注释

内容比较多，请仔细阅读，特别是图片上的说明，相信一定能帮上你。

1、方法级注释

在这里插入图片描述

在这里插入图片描述
下面给出我的模板内容：

**
 * @Title: $title$
 * @Description: $desc$
 $params$
 * @return: $return$
 * @throws: $throws$
 * @author: huangpeng
 * @Date: $date$ $time$
 */

EXpression表达式除 params 和 return 比较复杂，其余变量的表达式都可再图中看到（这些方法是系统内置的，可直接选，如果没有提示的话，照着图片输入即可），下面单独给出这两个变量的表达式：
（1）、params ：

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

（2）、return

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

唤出注释方式：按照图片上的设置的是输入 /* 后按回车唤出方法注释。
注意：throws 的表达式获取异常，idea目前没有合适的表达式可做到，上面的方法是失效的。

2、属性注释

在这里插入图片描述
注释模板：

/**
 * $desc$
 */

只需保留有变量即可，desc可自行设置为其他名字，图中设置的通过按 tab 加 f 键唤出注释。

二、类级注释和类文件级注释

1、类文件级注释

在这里插入图片描述

下面给出注释模板：

/**
 * 创建人:  @author xxxxxx    
 * 创建时间:  ${YEAR}年${MONTH}月${DAY}日 ${HOUR}:${MINUTE}
 * 项目名称:  ${PROJECT_NAME}
 * 文件名称:  ${NAME}
 * 文件描述:  @Description: ${Description}
 * 公司名称:  xxxxxx
 *
 * All rights Reserved, Designed By xxxxxx 
 * @Copyright:  2021-${YEAR}
 *
 */

2、类级注释

在这里插入图片描述

下面给出注释模板：

/**
 * 包名称：${PACKAGE_NAME}
 * 类名称：${NAME}
 * 类描述：${Description}
 * 创建人：@author xxxxxx
 * 创建时间：${YEAR}年${MONTH}月${DAY}日 ${HOUR}:${MINUTE}
 */

三、效果展示

新建一个类后会有提示输入类描述内容，点ok后类注释和类文件注释会自动生成。

在这里插入图片描述

这里发现一个问题@Copyright 描述标签会自动换行，同时在公司名称下面的空内容会多出一个“尖括号p尖括号”，发现将idea的代码格式化的格式化注释，关掉就正常了：

在这里插入图片描述
希望能帮助大家，大家觉得有用的话别忘了点个赞！

本文链接：https://blog.csdn.net/qq_41394352/article/details/121314701

原作者删帖不实内容删帖广告或垃圾文章投诉

智能推荐

while循环&CPU占用率高问题深入分析与解决方案_main函数使用while(1)循环cpu占用99-程序员宅基地

文章浏览阅读3.8k次，点赞9次，收藏28次。直接上一个工作中碰到的问题，另外一个系统开启多线程调用我这边的接口，然后我这边会开启多线程批量查询第三方接口并且返回给调用方。使用的是两三年前别人遗留下来的方法，放到线上后发现确实是可以正常取到结果，但是一旦调用，CPU占用就直接100%(部署环境是win server服务器)。因此查看了下相关的老代码并使用JProfiler查看发现是在某个while循环的时候有问题。具体项目代码就不贴了，类似于下面这段代码。while(flag) {//your code;}这里的flag._main函数使用while(1)循环cpu占用99

【无标题】jetbrains idea shift f6不生效_idea shift +f6快捷键不生效-程序员宅基地

文章浏览阅读347次。idea shift f6 快捷键无效_idea shift +f6快捷键不生效

node.js学习笔记之Node中的核心模块_node模块中有很多核心模块,以下不属于核心模块,使用时需下载的是-程序员宅基地

文章浏览阅读135次。Ecmacript 中没有DOM 和 BOM核心模块Node为JavaScript提供了很多服务器级别，这些API绝大多数都被包装到了一个具名和核心模块中了，例如文件操作的 fs 核心模块，http服务构建的http 模块 path 路径操作模块 os 操作系统信息模块// 用来获取机器信息的var os = require('os')// 用来操作路径的var path = require('path')// 获取当前机器的 CPU 信息console.log(os.cpus._node模块中有很多核心模块,以下不属于核心模块,使用时需下载的是

数学建模【SPSS 下载-安装、方差分析与回归分析的SPSS实现(软件概述、方差分析、回归分析)】_化工数学模型数据回归软件-程序员宅基地

文章浏览阅读10w+次，点赞435次，收藏3.4k次。SPSS 22 下载安装过程7.6 方差分析与回归分析的SPSS实现7.6.1 SPSS软件概述1 SPSS版本与安装2 SPSS界面3 SPSS特点4 SPSS数据7.6.2 SPSS与方差分析1 单因素方差分析2 双因素方差分析7.6.3 SPSS与回归分析SPSS回归分析过程牙膏价格问题的回归分析_化工数学模型数据回归软件

利用hutool实现邮件发送功能_hutool发送邮件-程序员宅基地

文章浏览阅读7.5k次。如何利用hutool工具包实现邮件发送功能呢？1、首先引入hutool依赖<dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>5.7.19</version></dependency>2、编写邮件发送工具类package com.pc.c..._hutool发送邮件

docker安装elasticsearch，elasticsearch-head，kibana，ik分词器_docker安装kibana连接elasticsearch并且elasticsearch有密码-程序员宅基地

文章浏览阅读867次，点赞2次，收藏2次。docker安装elasticsearch，elasticsearch-head，kibana，ik分词器安装方式基本有两种，一种是pull的方式，一种是Dockerfile的方式，由于pull的方式pull下来后还需配置许多东西且不便于复用，个人比较喜欢使用Dockerfile的方式所有docker支持的镜像基本都在https://hub.docker.com/docker的官网上能找到合..._docker安装kibana连接elasticsearch并且elasticsearch有密码

随便推点

Python 攻克移动开发失败！_beeware-程序员宅基地

文章浏览阅读1.3w次，点赞57次，收藏92次。整理 | 郑丽媛出品 | CSDN（ID：CSDNnews）近年来，随着机器学习的兴起，有一门编程语言逐渐变得火热——Python。得益于其针对机器学习提供了大量开源框架和第三方模块，内置..._beeware

Swift4.0_Timer 的基本使用_swift timer 暂停-程序员宅基地

文章浏览阅读7.9k次。//// ViewController.swift// Day_10_Timer//// Created by dongqiangfei on 2018/10/15.// Copyright 2018年飞飞. All rights reserved.//import UIKitclass ViewController: UIViewController { ..._swift timer 暂停

元素三大等待-程序员宅基地

文章浏览阅读986次，点赞2次，收藏2次。1.硬性等待让当前线程暂停执行，应用场景：代码执行速度太快了，但是UI元素没有立马加载出来，造成两者不同步，这时候就可以让代码等待一下，再去执行找元素的动作线程休眠，强制等待 Thread.sleep(long mills)package com.example.demo;import org.junit.jupiter.api.Test;import org.openqa.selenium.By;import org.openqa.selenium.firefox.Firefox.._元素三大等待