java - javadoc 工具能识别方法内的注释吗？

Question

我在我的业务逻辑中写了很多这样的评论：

/**
 * 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 将成为其中的一部分。

Answer 1

该javadoc工具是否也能识别我的方法块中的文档注释？

不。

JavaDoc 注释是一个多行注释，开头/**紧接在类声明或类的方法或属性之前。