JavaDoc @ MyClassコンストラクタが "参照が見つかりません"という警告を返します。

Question

クライアントライブラリのjavadocを作成しようとしています。 MyOtherClassでは、以下を@seeの下に置き、警告を受け取ります。 MyOtherClassとMyClassは同じプロジェクト内の異なるパッケージにあります。

@see MyClass#Constructor(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyClass#Constructor(Type1 param1, Type2 param2) 

は、その後、私は

@see MyClass#MyClass(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyClass#MyClass(Type1 param1, Type2 param2) 

を試してみました。また、私は私がここに本当の愚かな何かが欠けています知っている

@see #MyClass(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyOtherClass#MyClass(Type1 param1, Type2 param2) 

を試してみました。

Answer 1

これは、Javadocが参照先のクラスの正確な場所を知っているため、リンクを作成する必要があるためです。上記のようにパッケージを追加するだけです。

@see mypackage.MyClass#Constructor(Type1 p1, Type2 p2) 

Javadocツールは、次のようにショートカットを取ることができるようになります：

// For methods in the same class: 
@see #Constructor(Type1 p1, Type2 p2) 

// For methods in the same package: 
@see MyClass#Constructor(Type1 p1, Type2 p2) 

あなたが長いパッケージ名を持って、それを非表示にする場合は、ラベルを使用することができます。

@see mypackage.MyClass#Constructor(Type1 p1, Type2 p2) MyClass#Constructor(Type1 p1, Type2 p2) 

上記は表示されます：

参考：MyClass.Constructor(Type1 p1, Type2 p2)

が@see

---

警告の詳細については、Oracleのマニュアルを参照してくださいhere：をあなたには、いくつかのIDEのコード補完機能を使用する場合（例えば、 Eclipse）を使用して、Javadocコメントを作成します。代わりに、参照しているパッケージのインポートが追加される可能性があります。これにより、パッケージ名を除外してコメントをよりきれいに見せることができますが、ドキュメントのために実際の依存関係を追加するのは良い方法ではありません。