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

- s_bei

---

方法中的注释通常记录实现细节。JavaDoc应该描述类/方法的接口(API)。因此，这是两个不应混淆的独立事物。 - NilsH

Answer 1

问： javadoc 工具能识别方法块内的文档注释吗？

答：不行。

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

- Andrew Thompson