Javadoc Version und Autor über alle Dateien aktualisieren?

Question

Ich muss das @version Tag aller Klasse Javadocs in meinem Projekt, sowie das @author Tag synchronisieren. Allerdings kenne ich keine einfache Möglichkeit, dies zu tun.

Gibt es ein Plugin (vorzugsweise ein Maven-Plugin), das dies erreichen könnte? Und nein, das Maven-Release-Plugin wird das nicht für mich tun.

Answer 1

Die Art, wie ich @version verwende, ist in Verbindung mit @since. IMHO glaube ich @version Version der Software, wenn diese Klasse war geändert und @since stellt die Version der Software, wenn diese Datei/Klasse erstellt wurde.

Unter @author lautet meine Richtlinie, dass jeder Entwickler, der jemals zu dieser Klasse beigetragen hat (in einer größeren Weise), seinen/ihren Namen anhängen sollte.

Also, wenn Sie sehen, alle diese Prozesse sind manuell und müssen von Class Creator/Modifier zum Zeitpunkt der Codierung erfolgen. Und natürlich werden Sie eine ungleiche Version der Dateien haben. Und ich denke, das macht Sinn.

Ich würde gerne zuhören, wenn sich jemand darin unterscheidet.

Answer 2

Natürlich gibt es ein Maven Weg, es zu tun, aber es ist sehr ungewöhnlich:

Ihre src/main/java-Ordner als <resource>, mit einem festen ausgabe definieren. Dann javadoc und jar-Plugins, so etwas wie diese neu konfigurieren:

<build> 
    <resources> 
     <resource> 
      <directory>src/main/java</directory> 
      <targetPath>sources</targetPath> 
      <filtering>true</filtering> 
     </resource> 
    </resources> 

    <plugins> 
     <plugin> 
      <groupId>org.apache.maven.plugins</groupId> 
      <artifactId>maven-javadoc-plugin</artifactId> 
      <version>2.6.1</version> 
      <configuration> 
       <sourcepath>${project.build.outputDirectory}/sources</sourcepath> 
      </configuration> 
      <!-- other config stripped --> 
     </plugin> 
     <plugin> 
      <groupId>org.apache.maven.plugins</groupId> 
      <artifactId>maven-jar-plugin</artifactId> 
      <version>2.3</version> 
      <configuration> 
       <excludes> 
        <exclude>sources/**</exclude> 
       </excludes> 
      </configuration> 
      <!-- other config stripped --> 
     </plugin> 
    </plugins> 
</build> 

Jetzt können Sie Platzhalter in Ihren Quelldateien verwenden und interpolieren sie mit Maven Eigenschaften (siehe maven filtering als Referenz)