2012-01-19 5 views
0

別ファイルに配置したくない2つのクラスからなる短いファイルがあります。両方のクラスをリストするファイルのjavadocを作成するにはどうすればよいですか?今私はjavadocを生成するとき、それは2番目のクラスを無視します。 は、私が最初のクラスのdocコメントで同じファイル内の2つの別々のクラスのjavadocを作成する方法

@see class2Name 

を配置しようとしたが、それは単に第二のクラスの名前に非リンクを作成しました。 2番目のクラスが同じファイル内にあり、内部クラスではない場合の適切なアプローチは何ですか? ありがとう

+0

あなたのクラスの1つが他のクラスの中にネストされていますか、それとも非公開ですか? IIRCでは、デフォルトでJavadocは非公開クラスを無視します。 –

答えて

0

2番目のクラスを他のクラスと同様にjavadocできます。両方のドキュメントを生成する必要があります。 EclipseのJavadocビューを見ている場合は、選択肢(2つの矢印が付いたボタン)にリンクし、各クラスの内部をクリックしてjavadocを表示するか、単にクラス名の上にカーソルを置いてください。また、{@link ExpertImpl}に気付くと、2番目のクラスのドキュメントにリンクすることができます。

クイック例:

/** 
* This is class one. 
* 
* {@link ExpertImpl} 
* 
* @author Me 
* 
*/ 
public class ClassOne { 

} 

/** 
* This is class two. 
* 
* @author Me 
* 
*/ 
class ExpertImpl { 

} 

それは個人的な好みかもしれないが、私は同じファイルに複数のクラスを置くことに対して推薦する、と述べました。これは、あなたのプロジェクトの読みやすさを損なうものではありません。非公開クラスを独自のファイルに置くことを検討したり、それが意味をなさもなければ公開クラスの中に入れたりすることができます。お役に立てれば。

関連する問題