クラスファイルの最終更新日を指定する方法はありますか? 各 javadoc ページに、できればフッターに、クラス ファイルの最終更新のタイムスタンプを含めたいと思います。
しばらく前にこのようなことをしたと思っていましたが、ウェブ上で例を見つけることができず、フッターのドキュメントは単に html を含めることができることを示しています。では、javadoc の生成時に設定される任意の種類のプレースホルダーを持つことはできませんか?
ありがとう。
クラスファイルの最終更新日を指定する方法はありますか? 各 javadoc ページに、できればフッターに、クラス ファイルの最終更新のタイムスタンプを含めたいと思います。
しばらく前にこのようなことをしたと思っていましたが、ウェブ上で例を見つけることができず、フッターのドキュメントは単に html を含めることができることを示しています。では、javadoc の生成時に設定される任意の種類のプレースホルダーを持つことはできませんか?
ありがとう。
一部のソース管理システムでは、ファイルのコミット時に更新されるマーカーをコーディングできます。それをjavadoc内に置くと、javadocはリビジョン番号と最後にコミットされた時期を教えてくれます。
タイムスタンプをコードに書き込むのは編集者の仕事だと思います。これがEmacsのやり方です:
package my.tuple;
/**
* Implementation of an ordered 2-tuple.
*
* @date 2013-07-03
*/
public class Pair<A,B>
{
}
// Local Variables:
// time-stamp-pattern: "0/^ \\* @date %:y-%02m-%02d$"
// End:
その後、ドキュメント プロセッサは日付を読み取ることができます。しかし、標準の javadoc は日付を認識しません。これには Eclipse または Doxygen が必要です。
この機能は javadoc では利用できないと思います。この作業をソース管理に頼ってみませんか? SVN の場合、コミット時に自動的に入力されるキーワードを定義できます ( svn propsetを参照)。これははるかに優れており、javadoc の処理について心配する必要はありません。
より単純なアプローチで満足できる場合は、次のようなスクリプトを一番下のオプションに追加できます。
-bottom "<font size=\"-1\">Created by `echo $USER`, at `date +%Y-%m-%d\ %H:%M:%S.%N`.</font>"