問題タブ [javadoc]

パブリック要素の javadoc コメントとタグが欠落しているという警告を表示するように Eclipse を構成しています。これは、コードを適切に文書化するために非常に役立ちます。

しかし、時々私はクラスを持っています。そこでは、DFA の状態などを説明するいくつかの定数があります..これらの定数は自己説明的であるため、文書化する必要はありません..

だから私は注釈@SuppressWarnings("javadoc")をクラスに追加しました。これが私のポイントです.Eclipseは注釈を考慮せず、欠落しているjavadocに関する警告を表示します..

@SuppressWarnings("all")は仕事をしますが、それには望ましくない副作用があります;-)

同じ問題が発生していますか? これはバグですか、それとも設定が間違っているだけですか? 回避策はありますか？それとも、これは新しいバージョンで修正されていますか?

PS: 私はバージョンを使用しています: 3.3.2 ビルド ID: M20080221-1800

javadoc を html 形式で見たいのですが、パッケージ全体では見たくないのですが、これを行う方法はありますか。

以前に定義されたフィールドのコメントに基づいて、EclipseがgetterメソッドとsetterメソッドのJavadocコメントを自動的に生成するようにします。どうすればこれを達成できますか？

背景：当社のポリシーは、すべてのメソッドとフィールドにコメントを付けることです（わかりやすい名前が付いている場合でも）。したがって、フィールドを記述し、ゲッター/セッターを再度記述して、冗長な作業を行う必要があります。

例：

Webを検索したところ、問題を抱えているのは私だけではないことがわかりましたが、解決策は見つかりませんでした。http://jautodoc.sourceforge.net/をチェックアウトしましたが、これを実行できないようです。

私はこれでかなり苦労しています！

私はJavaドキュメントを次の場所にインストールしました：

file：///usr/share/doc/openjdk-6-jre/api/index.html

そして、そのファイルをロードすると、すべてのドキュメントが表示されます。

ただし、Eclipse内から直接参照して、クラスにカーソルを合わせたときにドキュメントを確認したいと思います。たとえば、「javax.servlet.http.HttpServletRequest」にカーソルを合わせると、そのドキュメントが表示されます。私が得るのは：

注：この要素には添付されたソースがなく、添付されたJavadocでJavadocが見つかりませんでした。

誰かが私の開発環境を修正するのを手伝ってもらえますか？

それに直面しましょう：デフォルトのJavadocが見苦しいことを確認するために、設計者である必要はありません。

Web上には、スタイルを変更したJavadocを提供するリソースがいくつかあります。ただし、デフォルトの動作は製品を表しており、適度に見栄えがよいはずです。

もう1つの問題は、Javadocの使いやすさが他の同様のリソースと比較して最新ではないという事実です。

特に巨大なプロジェクトは、Firefoxのクイック検索を使用してナビゲートするのは困難です。

実用的な質問：
ブラウザよりも使いやすい方法で既存のJavadocを参照できるスタンドアロン（デスクトップ）アプリケーションはありますか？
私はMonoのドキュメントブラウザのようなものを考えています。

理論的な質問：
Javadocを何らかの形で標準化された方法で進化させる計画があるかどうか、誰か知っていますか？
編集： このトピックに関するSunのwikiへの便利なリンク。

ゲッターとセッターにコメントするためにどのような規則を使用しますか？これは私がかなり前から疑問に思っていたものです。たとえば、次のようになります。

私はいつも、1a/bと2a/bについてまったく同じことを書いていることに気付きます。たとえば、1a）従業員の給与を設定し、1b）従業員の給与を設定します。それはとても冗長に思えます。今、私はあなたが文脈を与えるために（a）の部分でもっと書くかもしれないもっと複雑な何かを見ることができました、しかしそこにあるゲッター/セッターの大多数にとって、言葉遣いはほとんどまったく同じです。

単純なゲッター/セッターの場合、（a）の部分または（b）の部分のいずれかのみを入力してもよいかどうかだけが気になります。

どう思いますか？

を実行するmvn javadoc:javadocと、次のエラーが表示されます。

システムでコマンドを呼び出すと"C:\Program Files\Java\jdk1.6.0_14\jre..\bin\javadoc.exe"、javadoc 実行可能ファイルが実行されます。

私は走っています：

• JDK1.6.0_14
• Maven 2.0.8

私のPOMのjavadocレポート部分は次のようになります:

関連する環境変数:

Java と Maven の再インストール、Maven 2.1.0、JDK 1.6.0_11、さらには JDK 1.5.0_11 の使用を試みました。私のセットアップを、実質的に同じ環境で問題のない同僚と比較しました。約 1 か月前は機能していましたが、それ以降、システムで何が変更されたのかわかりません。JDK 1.6.0_11 で初めて遭遇しました。これは、リポジトリで試したすべてのプロジェクトで発生し、同僚は同じプロジェクトで問題を抱えていません。したがって、それは私の環境だけであり、プロジェクト自体ではないと確信しています。

これに関する提案をいただければ幸いです。

私は最近、コード ファイル内の JavaDoc の有効性をチェックするために DocCheck を使い始めました。

DocCheck を Eclipse プラグインとして設定する方法はありますか?

Javadocを含むソース ファイルの良い例はありますか?

インターネット上でJavadocの良い例をたくさん見つけることができます。それらを作成するために使用される特定の構文を見つけたいだけです.どこかのライブラリのソースを調べることができると思いますが、それは大変な作業のようです.