javadoc+lombok 如何生成正确的文档

最新推荐文章于 2023-05-09 15:59:38 发布

锥锋骚年

最新推荐文章于 2023-05-09 15:59:38 发布

阅读量970

点赞数

分类专栏： java lombok maven

本文链接：https://blog.youkuaiyun.com/downloads_zip/article/details/102529413

版权

java 同时被 3 个专栏收录

12 篇文章

订阅专栏

maven

4 篇文章

订阅专栏

lombok

1 篇文章

订阅专栏

本文介绍如何通过配置Maven插件，使Lombok注解的实体类在生成Javadoc时包含get和set方法的文档说明。通过lombok-maven-plugin和maven-javadoc-plugin插件，可以实现在Javadoc中展示由Lombok生成的代码。

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

javadoc+lombok生成的entity文档是没有get和set方法说明的，需要使用如下插件

pom.xml

 <plugin>
                <!--lombok还原插件-->
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok-maven-plugin</artifactId>
                <version>1.18.0.0</version>
                <configuration>
                    <encoding>UTF-8</encoding>
                    <sourceDirectory>src/main/java</sourceDirectory>
                </configuration>
            </plugin>
            <plugin>
                <!--函数文件生成插件-->
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>2.10.4</version>
                <configuration>
                    <sourcepath>target/generated-sources/delombok</sourcepath>
                </configuration>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                        <configuration>
                            <additionalparam>-Xdoclint:none</additionalparam>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

执行步骤: lombok:delombok -> javadoc:javadoc