javadoc工具可以识别方法内部的注释吗? [英] Does the javadoc tool recognize comments inside methods?

问题描述

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

I have written a lot of comments inside my business logic like that:

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

My question is, does the javadoc tool recognize the doc comments inside my method blocks too? In the near future we will offer a technical documentation and the JavaDoc of our project will be part of it.

推荐答案

javadoc工具是否也可以识别我的方法块内的文档注释?

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

否.

JavaDoc注释是从/**开始的多行注释，该注释紧接在类声明或该类的方法或属性之前.

A JavaDoc comment is a multi-line comment starting with /** that immediately precedes a class declaration or a method or attribute of the class.

这篇关于javadoc工具可以识别方法内部的注释吗?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！