2013-03-19 2 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) класса/метода. Так что это две разные вещи, которые нельзя смешивать в любом случае. – NilsH

ответ

15

ли инструмент javadoc распознает комментарии к документам внутри моих блоков методов?

Номер

JavaDoc комментарий является многострочный комментарий, начиная с /**, который непосредственно предшествует объявление класса или метода или атрибута класса.

Смежные вопросы