2013-03-19 12 views
11

javadocツールはメソッド内のコメントを認識しますか?私はそのような私のビジネスロジック内の多くのコメントを書かれている

/** 
* Do some important stuff. 
* @param pDog 
* @param pAllDogTraining 
* @return 
*/ 
@Overwrite 
public Map<DogId, Dog> doEvaluateAllDog(final Dog pDog, final Collection<DogTraining> pAllDogTraining) { 
final Map<DogId, Dog> lAllDogBad = new HashMap<DogId, Dog>(); 
final List<DogTraining> lAllDogTraining = new ArrayList<DogTraining>(pAllDogTraining); 

/** 
* Remove deleted entries. 
* Detailed description 
*/ 
removeDeletetTrainings(lAllDogTraining); 

/** 
* Set the priority for each training 
* - bad dogs 
* - nice dogs 
* - unknown dogs 
* Detailed description 
*/ 
Collections.sort(lAllDogTraining, new DogTrainingComparator()); 

// Iterate over training elements and set the conflict state 
for(..... 

私の質問は、javadocツールは、あまりにも私のメソッドブロック内のdocコメントを認識しないのですか?近い将来、技術文書を提供し、プロジェクトのJavaDocもその一部になります。

+5

メソッド内のコメントは、通常、実装の詳細を文書化します。 JavaDocは、クラス/メソッドのインタフェース(API)を記述する必要があります。とにかく混ぜ合わせるべきではない2つの別々のものです。 – NilsH

答えて

15

javadocツールは、私のメソッドブロック内のドキュメントコメントも認識しますか?

Javadocコメントは直ちにクラス宣言またはクラスのメソッドまたは属性に先行/**で始まる複数行のコメントです。

関連する問題