COMPARTE ESTE ARTÍCULO

Javadoc es una herramienta que genera documentación a partir de comentarios en código Java. Esta documentación puede ser muy útil para desarrolladores, ya que proporciona información sobre la estructura y el funcionamiento del código.

Cómo documentar en Javadoc en Eclipse

Para documentar en Javadoc en Eclipse, primero debemos añadir comentarios al código. Estos comentarios deben estar precedidos por el símbolo /** y deben terminar con */.

Dentro de los comentarios, podemos usar etiquetas para proporcionar información sobre el código. Las etiquetas más comunes son:

@author: El nombre del autor del código.
@param: Los parámetros de un método o constructor.
@return: El valor devuelto por un método.
@throws: Las excepciones que puede lanzar un método.
@deprecated: Indica que el código está obsoleto y no debe utilizarse.

Cómo generar documentación Javadoc en Eclipse

Una vez que hayamos añadido comentarios al código, podemos generar la documentación Javadoc. Para ello, debemos seguir estos pasos:

En el menú principal, seleccionamos Project > Generate Javadoc.
En el asistente que se abre, seleccionamos el proyecto para el que queremos generar la documentación.
Si queremos, podemos personalizar la configuración de la documentación.
Hacemos clic en Finish.

La documentación Javadoc se generará en una carpeta llamada javadoc dentro del proyecto.

Consejos para documentar en Javadoc

Los comentarios deben ser claros y concisos.
La documentación debe ser completa y exhaustiva.
Los comentarios deben estar actualizados con los cambios en el código.

Ejemplo de comentario Javadoc

Java

/**
 * Este método suma dos números.
 *
 * @param a El primer número.
 * @param b El segundo número.
 * @return La suma de los dos números.
 */
public int sumar(int a, int b) {
  return a + b;
}

Este comentario proporciona información sobre el método sumar(). Indica que el método suma dos números, que los parámetros son a y b, y que el valor devuelto es la suma de los dos números.

Conclusiones

La documentación Javadoc es una herramienta muy útil para desarrolladores. Proporciona información sobre la estructura y el funcionamiento del código, lo que puede ayudar a comprenderlo y a mantenerlo.

    
 
 
         
   Maria Del Carmen Hernandez Herrera 
 
 
 
  Contacte con Alejandro por recomendación de una compañera de trabajo a la cuál ayudó mucho en la preparación de unos exámenes muy complicados . La física y química para mi hija en este curso estaba siendo muy complicada, tanto es así ,que suspendió la primera evaluación y ella no había suspendido nunca, desde que acude a sus clases hay un antes y un después ...... Alejandro con su manera de explicar ha conseguido que las entienda , que pueda desarrollar los problemas que tenga confianza en sí misma....tanto es así que ha aprobado todos los exámenes....Paula está súper contenta y yo más!!!! Siempre que tengo alguna duda o que necesito modificar un horario responden super pronto y buscan solución motivo por el cuál recomiendo al 100% está academia. Muchas gracias por su ayuda.
  
 
        
   Arianna Del Campo Martín 
 
 
 
  Yo soy estudiante universitaria, muy finalista y que llegó a la academia con prácticamente cero base… Finalmente aprobé mi examen! Aquí de una manera diferente a lo que convencionalmente se espera de los profes, me enseñaron, muy cercanamente lo que me proporcionó confianza para no callarme las dudas y preguntar todo el tiempo. Me sorprendió que el profe que me dio clases en particular era como una enciclopedia andante, sin necesidad de mirar los libros me decía fórmulas de memoria que son difíciles de entender hasta con ellas delante. Recomiendo 100%
  
 
        
   Ariana García Esquivel 
 
 
 
  No he dudado ni por un segundo que haber asistido a las clases con Alejandro es lo mejor que me ha pasado… No solamente te apoya académicamente, sino que apoya al alumno a pesar de sus dificultades, y a mí me ha estado ayudando muchísimo y en mis peores momentos. Mil gracias por tus consejos, por siempre darme ánimos, por ser tan simpático que alegras las clases aburridas y por ser un profe tan bueno, son de estas personas que nunca olvidas.❤️👏🏻 También he de decir que Raúl, el otro profesor que se encuentra en la academia…es una persona que se preocupa por el alumno a que haga las cosas bien, con tranquilidad, está siempre pendiente a ti, tiene mucha paciencia, dedica a dar sus clases lo más dinámico posible, tiene mucha amabilidad con las personas, en definitiva… tengo a los dos mejores profesores del mundo, se os quiere mucho💓✨.
  
 
        
   Another Weasley. 
 
 
 
  He tenido muchos profes, y muchos particulares, pero como Alejandro ninguno, de verdad, me hace pensar que de verdad no soy tan mala en lo mío 🥺 me apoya muchísimo y me ayuda en todo lo que pueda con mi carrera, es un profesor 10 y una persona sobretodo 10000 Gracias Ale por preocuparte por tus alumnos, por intentar que estén motivados, que las clases sean entretenidas, y lo bien y fácil que explicas !  Para mi, LOS MEJORES 💖 -alba
  
 
        
   yarel febles 
 
 
 
  He entrado a la carrera de enfermería gracias a Alejandro, sin duda estoy súper contento con mi paso por aquí :)
  
 
        
   Ana Carina Benta 
 
 
 
  Gracias por el ambiente familiar
Gracias por la paciencia
Gracias por la enseñanza
Gracias por el apoyo
Gracias por la Motivación!!

Simplesmente Gracias!!

Recomendable 1000%
  
 
        
   Yanet Palacio valdes 
 
 
 
  Desde hace un tiempo mi hijo asiste a la academia, pensabamos no sacaba la eso y hoy con orgullo se gradúa de 4to de la eso,muy agradecida por los profesores,sobre todo su profe Alejando persona entrañable,justo, para el todo nuestro agradecimiento..⭐⭐⭐👌👌
  
 
        
   Mabett Duque 
 
 
 
  ¡De lo bueno lo mejor, y de lo mejor lo superior!
  
 
  
 
  
 
   La evaluación general en Google es 4.4 de 5, en base a 27 reseñas

¿QUÉ TE HA PARECIDO EL ARTÍCULO? Danos tu opinión al final de la página.
Deja tu comentario y ayúdanos a crecer.

¡SÍGUENOS EN TUS REDES FAVORITAS!
AYUDANOS A CRECER Y QUE LLEGUEMOS A TODAS LAS PERSONAS QUE NOS NECESITANA. SÍGUENOS EN TUS REDES.
Entra AQUÍ y elíge donde seguirnos.

Solicita más información