Want to create interactive content? It’s easy in Genially!

Get started free

Presentación Javadocs

Alejandro Rubens

Created on March 27, 2023

Start designing with a free template

Discover more than 1500 professional designs like these:

Practical Presentation

Smart Presentation

Essential Presentation

Akihabara Presentation

Pastel Color Presentation

Nature Presentation

Higher Education Presentation

Transcript

Presentación

Java doc

por: Alejandro Rubens Valladolid

Índice

1. Estructura de un comentario

2. Como Generar un javadoc

3. Etiquetas más usadas

4. Recomendaciones

5. Conclusión

Estructura de un comentario

Como generar un javadoc

Etiquetas más usadas

Etiquetas generales

@version

@Author

Informa de la versión actual del código

Añade al documento el autor del código

@see

@since

Indica la versión inicial en la que empezó

Añade un comentario de "También puedes ver..."

Etiquetas de método

@return

@param

Puede estar, se usa para explicar que devuelve el método

Debe estar, se usa para definir un parámetro

Recomendaciones

Algunas recomendaciones a tener en cuenta son:

  • Es importante escribir comentarios claros
  • Mantener una buena organización en los comentarios
  • Actualizar a menudo los comentarios
  • No repetir informacion innecesaria

Conclusión

¡GRACIAS!