Javadocのバージョンと作成者をすべてのファイルに更新しますか？

Question

私のプロジェクトのすべてのクラスJavadocの@versionタグと、@authorタグを同期させておく必要があります。しかし、私はこれを行う簡単な方法を知らない。

これを達成できるプラグインがありますか（できればmavenプラグインがありますか）。そして、いいえ、maven-releaseプラグインは私のためにこれをしません。

Answer 1

@versionの使用方法は、@sinceと併用してください。 IMHO、@versionは、このクラスがに変更されたときのソフトウェアのバージョンを表していると思います。と@sinceは、このファイル/クラスがのときにソフトウェアのバージョンを表します。です。

@authorで私の方針は、そのクラスに寄稿した各開発者が（大部分の方法で）自分の名前を追加する必要があります。

これらのプロセスがすべて手作業であり、コーディング時にクラス作成者/修飾子で処理する必要があることがわかりました。そして、明らかにあなたはファイルの不等なバージョンを持っています。そして、私はそれが理にかなっていると思う。

誰かが違うかどうか聞いてみたいと思います。

Answer 2

はもちろん、それを行うにはMavenの方法がありますが、それは非常に珍しいです：

が固定OUTPUTDIRECTORYで、<resource>としてあなたのsrc /メイン/ javaのフォルダを定義します。そこで、このような何かのjavadocとjarプラグインを再構成します。

<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> 

今、あなたはあなたのソースファイルでプレースホルダを使用してMavenのプロパティでそれらを補間することができます（参照用maven filteringを参照）