「javadoc」と「修正履歴」

私事

なんか、この日記のリンク元一覧にMSNの検索画面から「javadoc」と「修正履歴」で飛んで来たログが残ってる。
Googleとかで検索するといっぱい引っかかるのだけれど、MSNだとこの日記しか引っかからないらしい。
それなのに「javadoc」と「修正履歴」という単語を使ってはいるものの、「javadocにおける修正履歴」に関する情報は全く含まれていないので、ちょっと申し訳ない気になる。
なので、ちょっぴり「javadocにおける修正履歴」の話をば。

        • -

えっと、まず、J2SE1.4 SDK付属のjavadoc自体には修正履歴に関するタグはありません。
「@version」タグでバージョンを明示し、一般的なドキュメンテーションコメントとして任意の形式で履歴を残すという方法が妥当と思われます。
また、どうしてもタグで指定したいという場合にはjavadocを自作のカスタムドックレットで拡張することも可能です。
カスタムドックレットの詳細については下記URLを参照して下さい。

J2SE1.4 SDK付属のjavadocの説明（Win32用） http://java.sun.com/j2se/1.4/ja/docs/ja/tooldocs/win32/javadoc.html

J2SE1.4のJavadocのドックレットとかタグレットの説明 http://java.sun.com/j2se/1.4/ja/docs/ja/tooldocs/javadoc/index.html

また、javadocから目を離して修正履歴だけを考えた場合、CVSやSubversion等のバージョン管理ツールを使うことによって、ソースファイルの外部に（擬似的に）修正履歴の管理を委譲することが出来ます。
これらのツールは、任意のバージョンのファイルを指定して差分を出力することが出来ますので、コメントによる修正履歴よりも詳細に変更点を知ることが出来ます（ただし、その変更に対する「意味」は別途明記する必要があります）。

……こんな感じでいいでしょうか。