Início / coding / Perguntas / 77640904
Accepted
PatPanda
Asked: 2023-12-12 00:12:29 +0800 CST

aviso: não @param para campo em java 21 com javadoc

  • 772
  • O que estou tentando alcançar:

Gere javadoc para registros java 21 muito simples.

  • O que eu tentei:

Eu tenho este registro simples:

/**
 * The type Some record.
 */
public record SomeRecord(String someField) {
}

e este pom:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
        <outputDirectory>target/javadoc</outputDirectory>
        <reportOutputDirectory>target/javadoc</reportOutputDirectory>
        <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
    </configuration>
</plugin>

E estou executando este comando maven:

mvn clean install site -U javadoc:javadoc
  • Emitir:

Reproduzível 100%, entendo o seguinte:

SomeRecord.java:6: warning: no @param for someField
[WARNING] public record SomeRecord(String someField) {
[WARNING] ^
  • Pergunta:

O que está errado neste código? O que é isso @param? Lembro-me de um @Param para Spring, mas @param (minúsculas?) Como posso gerar sem o javadoc corretamente?

java

1 respostas

  1. Best Answer

    @param, no contexto Javadoc, é chamada de tag Javadoc (às vezes chamada de tags de bloco JavaDoc) e é usada para documentar o que o parâmetro específico será usado (ou seja, o que ele constitui no domínio). Isso não tem nada a ver com o Spring @Param.

    A Oracle diz que :

    Um comentário de documento é escrito em HTML e deve preceder uma declaração de classe, campo, construtor ou método. É composto de duas partes – uma descrição seguida por tags de bloco.

    Com relação a warning: no @param for someField, apenas diz que você não tem uma descrição (que deve ser criada por @param, no JavaDoc) para o someFieldparâmetro.

    Basta adicionar:

    /**
 *
 * The type Some record.
 * @param someField here goes your description of someField
 */
public record SomeRecord(String someField) {
}

    Por fim, fique atento, essa javadocferramenta irá avisá-lo sobre todos os locais onde espera algumas tags de bloco, mas não as encontra.

    • 2

relate perguntas