He escrito muchos comentarios dentro de mi lógica empresarial como ese:
/**
* 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(.....
Mi pregunta es, ¿la javadoc
herramienta también reconoce los comentarios de documentos dentro de mis bloques de métodos? En un futuro próximo ofreceremos una documentación técnica y el JavaDoc de nuestro proyecto será parte de ella.
¿La
javadoc
herramienta también reconoce los comentarios de documentos dentro de mis bloques de métodos?
No.
Un comentario de JavaDoc es un comentario de varias líneas que comienza con y /**
que precede inmediatamente a una declaración de clase o un método o atributo de la clase.
Este artículo se recopila de Internet, indique la fuente cuando se vuelva a imprimir.
En caso de infracción, por favor [email protected] Eliminar
Déjame decir algunas palabras