【Java】生成apoidoc文档文件夹及jar插件

Tiramisu2023

已于 2023-02-07 15:52:02 修改

阅读量1.1w

点赞数

分类专栏：学习记录 java基础文章标签： java maven mybatis

于 2023-02-07 15:50:45 首次发布

本文链接：https://blog.csdn.net/lubiancongzi/article/details/128920159

版权

java基础同时被 2 个专栏收录

19 篇文章 1 订阅

订阅专栏

学习记录

8 篇文章 0 订阅

订阅专栏



    <build>
        <plugins>
            <!--生成doc jar包-->
            <!--<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <show>private</show>
                    <nohelp>true</nohelp>
                    <charset>UTF-8</charset>
                    <encoding>UTF-8</encoding>
                    <docencoding>UTF-8</docencoding>
                    <doclint>none</doclint>
                    &lt;!&ndash;<doclint>all,-missing</doclint>&ndash;&gt;
                </configuration>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>-->

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>2.10.4</version>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <phase>package</phase>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                        <configuration>
                            <additionalparam>-Xdoclint:none</additionalparam>
                        </configuration>
                    </execution>
                </executions>

                <configuration>
                    <!-- 解决控制台乱码 -->
                    <!--<charset>UTF-8</charset>-->
                    <!--<encoding>UTF-8</encoding>-->
                    <!--<docencoding>UTF-8</docencoding>-->
                    <!--<encoding>UTF-8</encoding>-->
                    <!--<additionalparam>-Xdoclint:none</additionalparam>-->
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>

生成apoidoc文档文件夹及jar插件，解决一些注解不规范报错问题，放开使用 -Xdoclint:none

Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.10.4:jar (attach-javadocs) on project demo: MavenReportException: Error while generating Javadoc: 
Exit code: 1 - E:\Users\Yimi\IdeaProjects\demo-security-2023\src\main\java\com\example\demo\DemoApplication.java:14: ����: @param û��˵��
     * @param args
       ^
E:\Users\Yimi\IdeaProjects\demo-security-2023\src\main\java\com\example\demo\DemoApplicationaa.java:7: ����: δ֪���: date
 * @date�� 2023/2/7 15:20
   ^
E:\Users\Yimi\IdeaProjects\demo-security-2023\src\main\java\com\example\demo\DemoApplicationaa.java:15: ����: δ֪���: Copyright
 * @Copyright: 2023 www.glywzn.cn Inc. All rights reserved..
   ^
E:\Users\Yimi\IdeaProjects\demo-security-2023\src\main\java\com\example\demo\DemoApplicationaa.java:16: ����: δ֪���: attention
 * @attention: �����ݽ����ڹ���Զ������ͨ�ſƼ����޹�˾�ڲ����ģ���ֹ��й�Լ�������������ҵĿ��
   ^
E:\Users\Yimi\IdeaProjects\demo-security-2023\src\main\java\com\example\demo\pojo\RolePojo.java:7: ����: δ֪���: date
 * @date�� 2023/2/3 9:13
   ^
E:\Users\Yimi\IdeaProjects\demo-security-2023\src\main\java\com\example\demo\pojo\RolePojo.java:15: ����: δ֪���: Copyright
 * @Copyright: 2023 www.glywzn.cn Inc. All rights reserved..
   ^
E:\Users\Yimi\IdeaProjects\demo-security-2023\src\main\java\com\example\demo\pojo\RolePojo.java:16: ����: δ֪���: attention
 * @attention: �����ݽ����ڹ���Զ������ͨ�ſƼ����޹�˾�ڲ����ģ���ֹ��й�Լ�������������ҵĿ��
   ^

Command line was: "C:\Program Files\Java\jdk1.8.0_191\jre\..\bin\javadoc.exe" @options @packages

Refer to the generated Javadoc files in 'E:\Users\Yimi\IdeaProjects\demo-security-2023\target\apidocs' dir.