2013-03-19 13 views
11

Pisałem wiele komentarzy w moim logiki biznesowej tak:Czy narzędzie javadoc rozpoznaje komentarze wewnątrz metod?

/** 
* 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(..... 

Moje pytanie brzmi, czy narzędzie javadoc rozpoznać komentarze doc wewnątrz moja metoda bloków też? W niedalekiej przyszłości zaoferujemy dokumentację techniczną, a JavaDoc naszego projektu będzie jej częścią.

+5

Komentarze wewnątrz metody zwykle dokumentują szczegóły implementacji. JavaDoc powinien opisywać interfejs (API) klasy/metody. To dwie oddzielne rzeczy, które i tak nie powinny być mieszane. – NilsH

Odpowiedz

15

Czy narzędzie javadoc rozpoznaje również komentarze do moich bloków metod?

nr

Komentarz JavaDoc jest komentarz wielu linii począwszy od /** że bezpośrednio poprzedza zgłoszenia klasy lub metodę atrybutem klasy.

Powiązane problemy