Does the Javadoc tool recognize comments in methods?

I wrote a lot of comments in my business logic:

/**
 * 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(.....

My question is, does the Javadoc tool recognize the document comments in my method block? In the near future, we will provide technical documentation, and the Javadoc of our project will become a part of it

Solution

No,

A Javadoc comment is a multiline comment that begins with / * * and immediately precedes a class declaration or a class's method or property

The content of this article comes from the network collection of netizens. It is used as a learning reference. The copyright belongs to the original author.
THE END
分享
二维码
< <上一篇
下一篇>>