2016-09-05 14 views
-2

* .javaファイルに@sinceまたは@file JavaDocタグを使用していますか?私の場合、これらのタグは今日は本当に時代遅れです。私は本当にJavaDocタグ@fileか@sinceが必要ですか?

@file: どのような利点がありますか?ファイルを探したい場合は、IDEの「オープンリソース」機能を使用し、クラス名を入力します。 @fileタグはクラス名の繰り返しです。

@since 全く利点はありません。バージョン管理システムには何がありますか? (ライブラリには意味がありますが、特にプロジェクトについて話します)

あなたはどう思いますか?

+0

個人的に私は 'file'タグに同意しますが、会社のさまざまなプロジェクトで使用されている自己開発ライブラリには 'since'を使用します。これらのファイルはバージョン管理で効率的に追跡することはできませんが、著者、コンテンツ、変更の時刻を文書化する必要があります。それは、このセクションでの問題に関連した質問が好きで、意見についての議論が少ないことが、コミュニティがむしろ好きであると私は思っていました。 – Akunosh

+0

私の場合、著者タグが絶対に意味をなさすことは間違いありません。デプロイされたライブラリのバージョンごとに自動的にJavaDocを生成する必要があります。これは、あなたとあなたのライブラリのユーザーがすべてを明確に追跡できることを意味します。 – tiktak

答えて

5

JavaDocの注釈は、ライブラリを開発する開発者のためのものではありません。これらの情報は、このライブラリを使用する開発者用であり、バージョンコントロールシステムまたはソースプロジェクトへのアクセス権はありません。

+0

あなたは、ライブラリの各デプロイされたバージョンのJavaDocを生成する必要があります。これは、あなたとあなたのライブラリのユーザーがすべてを明確に追跡できることを意味します。 – tiktak

+0

@ user6444340申し訳ありませんが、私はあなたが言うことを理解していません。しかし、はいjavadocはライブラリのすべてのバージョンに属しています – Jens

+0

私は特に@sinceタグについて話します。私の意見では、最初の発生を知りたい場合は、それぞれのjavadocのすべてのメソッドを追跡できるので、これは時代遅れです。 – tiktak

2

特に@sinceアノテーションは、メソッドが利用可能なライブラリのバージョンが分かっているときに、非常に便利です。
たとえば、JDK APIドキュメントにはたくさんの例があります。古いバージョンと新しいバージョンの両方のAPIで動作するコードを処理しようとすると非常に便利です(たとえば、ワークステーションほとんどすべてのソフトウェアが1.7ランタイムで動作するため、1.7 JDKがインストールされていました)。
そして誰もが別のファイルをクリックするだけのIDEにアクセスできるわけではありません。特にサーバー上で作業する場合、コマンドラインとテキストエディタに制限されることがよくあります。

+0

これは引数ではありません。クリーンなソリューションは、サーバー環境をローカルで再現することです。このようにして、Eclipseは使用しているライブラリがワークステーションのJDKと互換性がないと伝えます。 – tiktak

+0

@ user6444340あなたは明らかに業界で働いたことがなく、現実の世界ではどのように動作するのかわかりません。完璧な世界で何らかの方法で動くべきことは、それが意味するものではなく、現実の世界がどんな形であれ完璧であるとは言えません。若干の学説がありますが実践的な経験はほとんどない、若者の間では非常に一般的な "あなたよりも優しい"態度を乗り越えてください。 – jwenting

+0

@sinceはライブラリにとって意味があることに同意します。私は業界で働いています。あなたのワークステーションを切り替えるJDKのバージョンは大きな魔法ではないはずです。また、バグのあるソフトウェアを配布したくない場合は、プロダクションサーバーをローカルに複製することが最優先事項になります。私は品質について話しています。 – tiktak

関連する問題