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

解决方法

does the javadoc tool recognize the doc comments inside my method blocks too?

没有.

JavaDoc注释是一个以/ **开头的多行注释,紧跟在类声明或类的方法或属性之前.

原文地址：https://www.jb51.cc/java/124211.html