javadoc アノテーションと maven-javadoc-plugin プラグイン

1. javadoc アノテーション タグ:

• @author: 著者クラス、インターフェースレベル

• @version: バージョンクラス、インターフェースレベル

• @deprecated: 非推奨のメソッド

• @param: メソッドとコンストラクターのパラメーター

• @return: メソッドの戻り値の型

• @see: 通常はリンクまたはテキストエントリを使用して参照コンテンツを指定するために使用されます

• @例外: 例外がスローされました

• @throws: スローされた例外、例外と同義

• @since: この変更または機能によって指定されたバージョンと時間を識別します。

2.maven-javadoc-pluginプラグイン

                    <!-- 生成API文档插件 -->
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-javadoc-plugin</artifactId>
                        <version>3.3.2</version>
                        <executions>
                            <execution>
                                <id>attach-javadocs</id>
                                <goals>
                                    <goal>jar</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>

Java プロジェクトにパッケージ化する場合、java アノテーションを jar パッケージにパッケージ化するために maven-javadoc-plugin プラグインが導入されますが、Java アノテーションが十分に標準的でない場合、例外がスローされ、通常のパッケージ化は行われません。以下の例外があります。

Command line was: /Library/Java/JavaVirtualMachines/jdk-11.0.10.jdk/Contents/Home/bin/javadoc @options @packages

Refer to the generated Javadoc files in '/Users/xx/Documents/IDE/workplace-java/spring-parent/emily-spring-boot-logger/target/apidocs' dir.

解決策: 以下の構成のように、failOnError パラメーターを追加して、ビルド プロセス中にエラーが発生した場合にビルドを停止するかどうかを制御します。

                    <!-- 生成API文档插件 -->
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-javadoc-plugin</artifactId>
                        <version>3.3.2</version>
                        <configuration>
                            <failOnError>false</failOnError>
                        </configuration>
                        <executions>
                            <execution>
                                <id>attach-javadocs</id>
                                <goals>
                                    <goal>jar</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>

ドキュメントの生成中にエラーが発生した場合でも、failOnError パラメーターを false に設定すると、ビルド プロセスは停止されません。

3. 指定されたパッケージを除外し、構築プロセス中に javadoc ドキュメントが正しいかどうかを確認します。

excludePackageNames パラメーターを使用して、除外するパッケージまたはアノテーションを指定できます。

                        <configuration>
                            <!--控制构建过程中如果出现错误是否停止构建-->
                            <failOnError>false</failOnError>
                            <!--排除指定的包，可以使用: or , or ; 三种符号分割-->
                            <excludePackageNames>com.emily.cloud.test.*,com.emily.infrastructure.test.*</excludePackageNames>
                        </configuration>

GitHub アドレス: https://github.com/mingyang66/spring-parent