Maven学习之路——IDEA生成类注释

最新推荐文章于 2024-05-26 10:11:51 发布

ipomonkey

最新推荐文章于 2024-05-26 10:11:51 发布

阅读量505

点赞数

CC 4.0 BY-SA版权

分类专栏： Maven

本文链接：https://blog.youkuaiyun.com/IPOmonkey/article/details/79821685

Maven 专栏收录该内容

6 篇文章

订阅专栏

本文介绍如何在IntelliJ IDEA中自定义文件注释模板，包括设置步骤及示例，帮助提升代码规范性和可读性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

第一步：打开左上角的File，点击Settings，选择Editor/File and Code Templates。

第二步：选择你需要填写的文件的注释，例如当前的class

第三步在窗口内写入自己需要的注释，例如;

/**
 *  Title:    ${NAME}
 *  Description:    ${description}
 *  @author dtt
 *  @data   ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

ipomonkey

关注关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

专栏目录

Maven插件 MyBatis generator plugin进阶使用——插件全面教程

AI天才研究院

07-28

1902

Maven 插件 MyBatis Generator 插件是一个可以自动生成 MyBatis 的 DAO 层代码的工具。它支持多种数据库（Oracle、MySQL等）、各种ORM框架(mybatis-plus/jpa/hibernate)以及自定义模板自定义配置。本文将详细介绍 MyBatis Generator 插件的功能及用法，并结合实际案例，对插件进行一些拓展和改造，让读者真正体会到 MyBatis Generator 插件的强大功能。2. 本文使用的技术栈：JavaMaven。

maven 打包添加注释

CAO的专栏

01-16

5917

<build> <plugins>  <plugin> <groupId>org.apache.maven.plugins</groupId> <art...

参与评论您还未登录，请先登录后发表或查看评论

Intellij IDEA 通过数据库表生成带注解的实体类详细步骤

Hunter的博客

06-04

8万+

前言：idea 功能很强大，以前不知道有这样的提升工作效率的方法，虽然有的工具确实可以直接生成实体类，mapper文件，还有dao接口，但是个人觉得涉及到复杂业务还是只生成实体类比较好，后面部分就自己搞定就可以了。一、连接数据库打开项目： 1、点击右侧的datesource图标，要是没有该图标，请去自行百度 2、点击 + 号 3、选择 datasource 4、选择 mysql...

idea给maven下载的源码添加注释

人的大脑是cpu，而不是硬盘

07-26

914

问题描述：idea无法对maven下载的源码添加自己的注释，导入自己在github上下载的源码又不匹配问题分析：maven不让我们直接修改下载的源码，以避免使用过程产生的不可预期的问题解决思路：将通过maven下载的source压缩包解压到非本地仓库目录，删除maven上的source，导入解压后的source 解决步骤： 1.将通过maven下载的source压缩包解压到非本地仓库目录 2.在file-setting-Libraries中找到对应jar包 3.删除原有source

idea 解决查看源码没有注释

weixin_42412601的博客

06-12

1万+

maven: 1.File->setting->maven->Importing 勾选Sources Documentation 2.右键 pom.xml maven->reimport 然后去查看源码，如果没有出现注释，出现的是反编译后的文件，只需要点击编辑窗口右上方的 “Download Sources” 即可。 ...

idea快捷生成注释

qq_35423970的博客

07-04

767

1.↓ 兵贵神速 2.↓点击模板组 3.下自定义命名组名 4.↓复制以下代码 @1处所指的是生成注释样式缩写：/** @3处可自定义作者描述 @4处自己名称（自定义） 5.↓复制以下代码 6.↓ 7.↓ 8.↓ 步骤大同小异.........

本项目是IntelliJ IDEA的插件，能帮助java开发者自动生成javadoc文档注释

05-21

1. 源代码：插件的实现逻辑，可能分为多个Java类，用于解析代码结构，生成注释模板。 2. 插件配置文件：描述插件的元数据，如版本、作者、依赖等。 3. 构建脚本：可能包含Gradle或Maven等构建工具的配置，用于编译和...

Maven仓库安装以及IDEA配置Maven仓库

一介布衣Jacob的博客

07-16

2528

这里写自定义目录标题欢迎使用Markdown编辑器新的改变功能快捷键合理的创建标题，有助于目录的生成如何改变文本的样式插入链接与图片如何插入一段漂亮的代码片生成一个适合你的列表创建一个表格设定内容居中、居左、居右SmartyPants创建一个自定义列表如何创建一个注脚注释也是必不可少的KaTeX数学公式新的甘特图功能，丰富你的文章UML 图表FLowchart流程图导出与导入导出导入欢迎使用Markdown编辑器你好！这是你第一次使用 Markdown编辑器所展示的欢迎页。如果你想学习如何使用Mar

Maven——Maven核心概念——史上最烂系列

qq_44891295的博客

02-11

846

Maven 是目前最流行的自动化构建工具，对于生产环境下多框架、多模块整合开发有重要作用。Maven 是一款在大型项目开发过程中不可或缺的重要工具。（自己粗略写了一个SSM项目之后，回顾头来看这个，会发现更有感觉）文章目录1：Maven核心概念介绍1.1 约定的目录结构1.2 POM1.3 坐标1.4 仓库1.5 依赖1.5.1 依赖的目的是什么？1.5.2 依赖的范围1.5.3 依赖的传递性...

IDEA——mybatis-generator自动生成dao/model/mapper

Adele的专栏

02-23

5437

本文将记录利用mybatis生成器插件自动生成生成实体类model、dao和mapper映射文件。开发工具：IntelliJ IDEA2017.3.3 项目数据库为springdemo.sql，数据库中有两张表blog和user，将通过mybatis-generator插件来生成blog和user对应的dao、model和mapper。以下是我的项目结构：步骤如下： 1.创建M...

IDEA快速生成类注释和方法注释的方法

shenxiaomo1688的博客

05-26

1512

注意，下面红框我用其他快捷方式不生效，后面用一个*号，然后在方法上方输入/**按回车就生效了。可在方法上方空行输入/** 按enter键快速生成。1.生成类、接口、枚举、注解等文件的注释，不仅仅是class。

IDEA如何使用javadoc工具导出API 文档和注解@Documented的具体作用

一切总会归于平淡

01-05

1539

IDEA使用javadoc工具步骤： Tools->Generate JavaDoc->配置好相关事项

MAVEN XML文件注释大全

bobshute的专栏

12-29

2973

span style="padding:0px; margin:0px">project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM

idea生成类注释和方法注释的正确方法

热门推荐

Just do it!

11-01

30万+

目录目录生成类注释生成类注解模板生成方法注释生成方法注解模板最近从eclipse转idea了，第一步当然是配置快捷键，模板等。但是！发生了一件贼蛋疼的事情，竟然一直找不到正确添加方法注释的方法！最后自己摸索到了，在此详细记录，供大家参考。本人用的idea for mac，可能快捷键不同，但是设置等肯定是相同的生成类注释打开Preferences Editor -> Fil

IDEA注释详解

ZZHMMD957

03-19

1194

目录目录生成类注释生成类注解模板生成方法注释生成方法注解模板最近从eclipse转idea了，第一步当然是配置快捷键，模板等。但是！发生了一件贼蛋疼的事情，竟然一直找不到正确添加方法注释的方法！最后自己摸索到了，在此详细记录，供大家参考。测试版本为idea for mac，可能快捷键不同，但是设置等肯定是相同的 12生成类注释打开PreferencesEditor -> File and ...

注释生成Api文档

weixin_33923148的博客

09-23

347

1.开发背景最近一直在写dubbo接口，以前总是用word文档写接口描述然后发给别人。现在太多了，而且跟别人对接联调的人家急着用，根本没时间去写word文档。那就想想怎么用doc文档注释自动生成接口文档了。本来以前对这一块有点印象，但是并不熟悉，加上没有很强烈的要去使用的意图，所以一直没有弄。今天要感谢公司的大神，大家都叫他欧神，神一样的男人。让我用文档注释。然后就知道怎么弄了，以下是生成的流...

idea+maven+springboot源码无注释问题

weixin_38035834的博客

03-27

2407

问题描述： idea查看springboot相关源码无注释（之所以看得见源码，是idea自身反编译）疑问：使用idea工程右侧maven project栏下载resources和doc，会出现下载进度条但很快消失，直觉上是下载了，但是查勘源码还是无注释，网上介绍的很多方案都试过了，未果。按照maven的pom.xml文件中的GAV去本地仓库查找，发现确实没有sources.jar这样的文...

IDEA自动生成方法和文件注释（实用）

06-20

2879

IDEA自动生成方法和文件注释（实用） 1.定义Java文件注释打开idea，按照以下步骤打开 File => setting => editor => File and Code Templates 在里面配置自己想要的设置，如： ** *@描述 *@创建人 LiuSenChuan *@创建时间 ${DATE} *@修改人和其它信息 */ Apply——&gt...

将JavaDoc 注释生成API文档

weixin_40425415的博客

07-20

6353

将JavaDoc 注释生成API文档 1. 打开java代码，编写JavaDoc 注释，只有按照java的规范编写注释，才能很好的生成API文档，javadoc注释与普通注释的区别为多一个*（星号）。普通代码注释为/*XXX*/，而javadoc的注释为/**XXX*/ 2. javadoc注释要尽量写的详细，这样别人在没有源码的情况下才知道如何使用您的代码。 3. 点击ecl...

idea创建mapper自动生成注释

最新发布

03-18

### 如何在 IntelliJ IDEA 中配置 MyBatis Mapper 文件并实现自动添加生成注释功能 #### 自动化工具的选择与安装为了简化开发流程，可以通过插件来增强 IDE 的功能。推荐使用 **MyBatisX** 插件[^3]，它能够帮助开发者快速完成以下任务： - 自动生成基于 `Mapper` 方法的 XML 结构。 - 提供 DAO 和 Mapper 映射文件之间的相互导航能力。 #### 安装 MyBatisX 插件 1. 打开 IntelliJ IDEA 并进入设置界面 (`File -> Settings`)。 2. 转到 `Plugins` 页面，搜索 “MyBatisX” 插件。 3. 单击安装按钮，并重启 IDE 使更改生效。 #### 配置 Generator Config 文件通过 Maven 或 Gradle 工具配合 generatorConfig.xml 来定义自动化生成规则。以下是典型的 `pom.xml` 配置片段： ```xml <build> <plugins> <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.4.0</version> <configuration> <verbose>true</verbose> <overwrite>true</overwrite> </configuration> <dependencies> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.26</version> </dependency> </dependencies> </plugin> </plugins> </build> ``` 上述代码用于指定 MyBatis Generator (MBG) 的依赖项以及运行参数[^1]。 #### 设置 generatorConfig.xml 此文件描述了数据源连接信息、目标项目路径以及其他选项。下面是一个简单的例子： ```xml <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"> <generatorConfiguration>  <classPathEntry location="/path/to/mysql-connector-java.jar"/> <context id="DBContext" targetRuntime="MyBatis3"> <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/testdb?useSSL=false&serverTimezone=UTC" userId="root" password="password"/> <javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java"/> <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"/> <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java"/> <table tableName="users" domainObjectName="User"/> </context> </generatorConfiguration> ``` 这段脚本会依据 MySQL 表格结构创建对应的 Java 类型和 SQL 映射文档。 #### 解决自动注入警告问题如果遇到类似于 `@Autowired` 注入失败的情况，则需调整服务层的设计模式或者优化 Spring 上下文扫描逻辑。例如采用构造函数方式初始化 Bean 实例[^2]: ```java @Service public class UserService { private final UserRepository userRepository; public UserService(UserRepository userRepository){ this.userRepository = userRepository; } } ``` 对于某些特定场景下的错误提示（比如超出语言作用域），可能是因为编辑器未能正确认识自定义标签语法所致。此时可尝试修改 File Type Association 设置或将相关区域标记为纯文本处理[^4]。 #### 自动生成注释的方法当一切准备就绪之后，利用 MyBatisX 功能即可轻松达成目的——只需右键点击任意位置选择 Generate Actions... ，接着按照向导指示操作便可获得完整的注解样式。