Hola te saluda Jubal lacosta bienvenidos nuevamente.
Espero que estén listos para comenzar con esta elección.
Vamos a estudiar a continuación el tema de cómo documentar un programa en Java utilizando Java Doc.
Están listos.
Vamos
Java Doc en Java Java permite documentar nuestras clases por medio de Java Doc el cual es un documento
HTML que muestra la documentación de cada una de las clases de un proyecto en Java podemos observar
que a diferencia de los comentarios normales de Java es decir con doble diagonal o con Diagonal asterisco
para que nuestro comentario sea incluido dentro del documento HTML generado es necesario que los comentarios
tengan la forma de Diagonal doble asterisco y se cierran con asterisco diagonal dentro de esto se agrega
el comentario de Java Doc y de esta manera se puede ir documentando ya sea la clase un atributo un constructor
o un método así que en el código mostrado se muestran varios ejemplos de cómo documentar cada una de
las secciones de nuestra clase.
Podemos observar también que se pueden utilizar algunos elementos para indicar algunas características
más de la documentación como son arroba autor arroba Berjón arroba Robuchon.
Entre algunos elementos más y el resultado de generar el Java Doc de esta clase es como sigue.
Vamos a poder observar que tenemos por ejemplo un nombre de paquete si es que estuviera asignado a alguno.
Posteriormente el nombre de la clase.
También podemos observar que esta clase debido a que no extiende de ninguna otra clase entonces hereda
de manera automática de la clase obvie la cual se encuentra dentro del paquete Java punto Langue y posteriormente
se muestra cada uno de los elementos que hemos documentado desde los atributos métodos o constructores
de la clase.
A continuación vamos a ver algunos elementos más cuando utilizamos Babadook
caracteres de escape al utilizar cadenas en la tabla mostrada podemos observar los elementos que se
pueden utilizar al momento de documentar nuestras clases cada uno de los elementos mostrados tiene una
breve descripción para que tengamos conocimiento de qué significa cada uno de ellos y en el ejercicio
que vamos a realizar a continuación vamos a poner en práctica varios de estos elementos.
Por ejemplo el elemento de Assor significa el nombre del autor del programa arroba Eudes indica que
el elemento es obsoleto pertenece a versiones anteriores y ya no se recomienda su uso arroba paraun
define un parámetro de un método a robar Critón es la descripción de lo que devuelve el método y no
se utiliza en el constructor o en métodos de tipo bait ya que estos métodos o constructores no regresan
ningún tipo arroba si indica que se asocia con otro método u otra clase arroba derechón indica la versión
del método o clase que se está utilizando en el ejercicio que realizaremos a continuación pondremos
en práctica el concepto de Java DOGC utilizando el lenguaje Java.