web-dev-qa-db-ja.com

@JavaDocのバージョンx.yで非推奨

This 質問とその回答は役に立ちますが、私の問題には十分ではありません。

私の質問は、javadocを@ Deprecatedとして追加したい場合です。バージョンxyの時点で、現在のファイルのjavadocで{@link SomeClass}に置き換えられています。バージョン番号である必要があります。 x.yの代わりに??

私の現在のバージョンを1.2とし、CVSチェックイン後は1.3になります

1
Soumyadip Das

あなた以外の誰もCVSリビジョン番号を気にしません。これらは、使用するメカニズムの内部アーティファクトです(代わりに、Gitを使用した場合、リビジョンIDは完全に異なり、明確なシーケンスはありません)。

代わりに、releasesの観点からバージョンを定義する必要があります。ここで、「これは全体として使用するのが理にかなっているコードの構成です」と言い、で参照する必要があるのはそれらのバージョンです。特に非推奨の通知などのドキュメント。結局のところ、APIのコンシューマー(非推奨通知のコンシューマーとなる人々、およびそれらが作成するソフトウェア)に表示されるのはこれらのバージョンです。リビジョン管理システムの観点から、リリースバージョンは、通常、タグまたはラベルを使用してモデル化するのが最適な種類のものです。

まだリリースを行っていない場合は、何も非推奨にする必要はありません。過去にリリースを取得したことがある場合、非推奨の通知にはnextリリースバージョンを記載する必要があります。 (ただし、リリースされたばかりのバージョンについては言及しないでください。静的なアーティファクトと見なす必要があります。)

6
Donal Fellows