如何让Maven Help插件显示Latex插件的嵌套配置参数？

1. 规范嵌套类与属性的注解 #

• 嵌套参数类（比如Settings）得是公共类（加public修饰）；如果是放在Mojo类内部的嵌套类，必须是public static类型，否则Maven无法扫描到。
• 嵌套类中每个需要被Help插件展示的属性，都要添加@Parameter注解，建议带上description（方便使用者理解）、name（可选，默认用属性名）、defaultValue（可选）这些配置项。
• 若属性设为private，必须配套对应的setter方法——不管是Maven注入参数还是Help插件扫描信息，都需要能访问到这些属性。

示例代码：

// 要么是独立公共类，要么是Mojo内的公共静态内部类
public static class Settings {
    @Parameter(name = "outputDir", defaultValue = "${project.build.directory}/latex",
               description = "存放生成LaTeX文件的目录")
    private File outputDir;

    @Parameter(name = "maxRetries", defaultValue = "2",
               description = "LaTeX编译失败后的最大重试次数")
    private int maxRetries;

    // private属性必须配套setter方法
    public void setOutputDir(File outputDir) {
        this.outputDir = outputDir;
    }

    public void setMaxRetries(int maxRetries) {
        this.maxRetries = maxRetries;
    }
}

// Mojo类中的顶层参数
@Mojo(name = "compile")
public class LatexCompileMojo extends AbstractMojo {
    @Parameter(name = "versionsWarnOnly", defaultValue = "false",
               description = "版本不兼容时仅警告，不终止构建")
    private boolean versionsWarnOnly;

    @Parameter(name = "settings", description = "LaTeX构建的核心配置参数")
    private Settings settings;
}

2. 正确配置maven-plugin-plugin #

在插件的pom.xml中，使用3.6.0及以上版本的maven-plugin-plugin（版本太旧可能不支持嵌套参数扫描）；如果嵌套类不在Mojo类同包下，需要指定扫描范围：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-plugin-plugin</artifactId>
            <version>3.6.4</version>
            <executions>
                <execution>
                    <id>default-descriptor</id>
                    <goals>
                        <goal>descriptor</goal>
                    </goals>
                    <configuration>
                        <!-- 扫描插件所有相关类，包含嵌套类 -->
                        <includes>
                            <include>com/yourcompany/plugins/latex/**/*.java</include>
                        </includes>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

3. 验证plugin.xml生成结果 #

打包插件后，查看target/classes/META-INF/maven/plugin.xml文件，确认settings参数下是否包含嵌套属性的节点，示例如下：

<parameter>
    <name>settings</name>
    <type>com.yourcompany.plugins.latex.LatexCompileMojo$Settings</type>
    <description>LaTeX构建的核心配置参数</description>
    <parameters>
        <parameter>
            <name>outputDir</name>
            <type>java.io.File</type>
            <default-value>${project.build.directory}/latex</default-value>
            <description>存放生成LaTeX文件的目录</description>
        </parameter>
        <parameter>
            <name>maxRetries</name>
            <type>int</type>
            <default-value>2</default-value>
            <description>LaTeX编译失败后的最大重试次数</description>
        </parameter>
    </parameters>
</parameter>

只要plugin.xml包含上述嵌套参数节点，执行mvn latex:help -Ddetail=true时，Help插件就会递归展示所有叶子参数。

4. 新增嵌套类的扩展规则 #

后续添加更多嵌套参数类时，只需遵循以下规则：

• 嵌套类为public（或Mojo内的public static内部类）
• 类内属性均添加@Parameter注解并配置描述信息
• 确保maven-plugin-plugin能扫描到这些类

Help插件会自动识别所有嵌套的叶子参数，无需额外配置。

内容的提问来源于stack exchange，提问作者user2609605