Stefan Beike Stefan Beike - 1 year ago 50
Java Question

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


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.

Answer Source

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

No.

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

Recommended from our users: Dynamic Network Monitoring from WhatsUp Gold from IPSwitch. Free Download