Инструмент 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 комментарии документа внутри моих блоков методов? В ближайшем будущем мы предложим техническую документацию, и JavaDoc нашего проекта станет ее частью.

Ответы

Ответ 1

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

Нет.

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