問題タブ [inheritdoc]

Eclipse で使用する{@inheritDoc}と、スーパークラスの javadoc コメントがクラスの javadoc に表示されません。

次のコードがあります。

rt.jarライブラリ ( を含むjavax.swing.table.AbstractTableModel) にソース コードと javadoc の場所が設定されてgetRowCount()いることを確認しAbstractTableModelます。Eclipse から javadoc を生成するとき、「参照されたアーカイブとプロジェクト」セクションrt.jarが選択されていることを確認します。しかし、継承ドキュメントは機能しません。

{@inheritDoc}このクラスを使用して、抽象クラスからメソッドを継承したいと考えています。抽象クラスのドキュメントでは、抽象クラスを名前で参照しています。サブクラスがスーパークラスからドキュメントを継承するときに、抽象クラスの名前をサブクラスの名前に置き換えるにはどうすればよいですか?

Antタスクを使用してプロジェクトのドキュメントを生成します。いくつかの場所で、標準クラスからドキュメントを継承したかったので{@inheritDoc}、EclipseでJavadocを表示できるように使用しましたが、HTMLファイルには表示されませんでした。問題は、解凍したsrc.zip（J2SEソース）をソースパスに含めていなかったことです。これを修正した後、のようなファイルでのSun独自のAPIの使用について数百の警告が表示されるようになりlib/jdk-src/java/lang/Class.javaました。

これらの警告を抑制する方法はありますか？この混乱の中で関連する問題を見つけるのは難しいです。

私が考えた解決策は、ソースパスにJ2SEソースを含めずにJavadocタスクを1回実行することでした。これにより、実際の問題が明らかになります。次に、J2SEソースを含めてJavadocをもう一度実行し、出力を完全に破棄します。これにより、適切に機能するドキュメントが作成されます{@inheritDoc}。Antでこれを達成するための最良の方法については完全にはわかりません。言うまでもなく、Javadocを2回実行すると汚い修正になります。

助言がありますか？

私は数か月間答えを探していましたが、圧縮フォルダー src.zip を解凍し、それを Javadoc のパラメーターとして使用するなど、複数のことを試しました (例: javadoc -sourcepath src com.example.test)

これは、JDK 6 Update 24 に付属するデフォルトの Javadoc です。

java.util.Mapインターフェイスを実装する新しいマップに取り組んでいるとしましょう。デフォルトでは、Map インターフェースからオーバーライドするメソッドは、インターフェースからドキュメントを継承する必要があります (私の間違いでなければ)。ただし、javadoc は決してそれを行いません。

これまでのところ、この問題を解決した唯一の方法は、Java によって記述されたクラスを実際に javadoc 化することです (例: javadoc com.example.text java.util)。Javaクラスを書き直したように見えるので、これをしたくありませんが、これが唯一の方法ですか? もしそうなら、私はそれで暮らすことができると思いますが、これを行う別の方法があることは私の理解でした.

ありがとう =) これが少し乱雑でしたら申し訳ありません。スタック オーバーフローを使用するのはこれが初めてです。また、この質問が既にされている場合は申し訳ありません。私が聞きたいことすべてをカバーしていないという類似の質問をたくさん読みましたが、Javadoc の独自の実装を作成する必要があるため、非常に紛らわしいことがわかりました。とにかく、高度にありがとう=）

編集: 5 月 25 日 4:44

わかりました =) 私の理解が正しければ、例を見たいと思います。これは、うまくいかないことを試みていたことが原因であるかどうかを確認しようとした、より単純な例です。

この例 (ファイル名はUpperCaseObject.java) をディレクトリに移動し、javadoc-test/com/example別のディレクトリを作成して (src.zip から) その中にjavadoc-test/java/lang配置しました。Object.java

私が行った javadoc への呼び出しは、ディレクトリからのものでした。path パラメータに jdk6 bin ディレクトリがあります。javadoc -link http://download.oracle.com/javase/6/docs/api/ com.examplejavadoc-test

私が期待していた 2 つのことはUpperCaseObject.hashCode、すべてのドキュメントとUpperCaseObject.toString、追加の段落の前のすべてをjava.lang.Object. しかし、残念ながら、私はドキュメントを入手できませんでした。

編集：

さて、私がしなければならなかったのは次のことでした。これは単純な回避策です。

1. 通常どおり、source.zip からすべてのソース ファイルをコピーしました。
2. 各パッケージのパッケージファイルも作成しました。それらには、最初の段落 (概要を含む段落) と、「詳細については、Java™ プラットフォーム、Standard Edition 6 API 仕様のパッケージの概要を参照してください」という 2 番目の段落が含まれています。
3. ソース ファイルは基本的に、スーパー クラス、それらのスーパー クラス (およびインターフェイス)、およびそれらがスローしたすべての例外であり、それらも同じパッケージに含まれていました。唯一の例外は、Object を取得するだけでよい java.lang でした。例外がスローされたクラスと同じパッケージにある場合、java.lang を除いて、他のパッケージはリンクされないため、例外も必要でした。
4. 使用/サブクラス化/例外スロー元のすべてのパッケージを javadoc しました。
5. 標準パッケージと私自身のパッケージに関する情報を概要ファイルに含めるようにします。

残念ながら、今のところ回避策しかありませんが、私のバージョンの Java に問題がある可能性があると確信しています。他の人も同様の問題を抱えていて、独自の回避策を考え出したようです。これは私のものです=）

私はまだ回答を求めていますが、当面はこれが最も便利なオプションです。どうもありがとうございました！

私はこのようなコメントがあります：

実装方法については、同じドキュメントが欲しいのですが、それらの段落がなくてもid="0"、を使用してinheritdocいます。inheritdoc要素を作成するにはどうすればよいですか？

このコンテキストでの属性のまれな使用によりid、ドキュメントに表示されている段落の順序に縛られないという柔軟性が追加されます。

私は Stylecop 4.7.31 を使用しようとしています インターフェイスが宣言されているプロジェクトがあります:

および別のプロジェクトで、インターフェイスの実装:

??? の代わりに使用<inheritdoc />すると、Stylecop はそれを無視してエラーを生成します。

私が間違っていることについて何か考えがありますか？Google によると、Stylecop はこのタグをおよそ 4.1 バージョンからサポートしています。

親からすべてのドキュメントを継承したい場合、phpDocumentor の @inheritDoc の正しい構文は何ですか? おそらく、複数の構文が正しいのでしょうか?

1. @inheritDoc
2. {@inheritDoc}
3. @inheritdoc
4. {@inheritdoc}

ドキュメントはかなり曖昧だと思います。PhpStorm はそれらすべてをサポートしているようですが、構文によってはドキュメントの生成に問題があるのではないでしょうか?

最近、PHP 用の Eclipse を新しいラップトップにインストールし、TYPO3.Flow からパッケージをチェックアウトしましたが、Eclipse で「このファイルをフォーマットする」オプションを使用するたびに、プロパティの上のコメント注釈にある {@inheritdoc} のすべてのインスタンスが置き換えられます。 / @ERROR を使用したメソッド!!! (感嘆符を含む)

PHPStorm で試してみましたが、動作は発生しません。{@inheritdoc} 注釈は単純に無視されます。

私はこれまで見たことがなく、グーグルでそれについて何も見つけることができません. なぜこうなった？