Hola y bienvenidos a esta elección.
A continuación vamos a revisar el tema de IAVA Dog documentación en Java están listos.
Vamos bien lo que vamos a hacer es crear un nuevo proyecto.
Abrimos nuestra idea de Apache NetBeans damos un enfile mi proyecto seleccionamos llevar Wild Maiden
ya la aplicación Damos Siguiente y el nombre del proyecto se va a llamar.
Ejemplo Ya Balog y lo vamos a depositar en la carpeta de cursos.
Diagonal Llada el nombre del Grup oiría cm x com G.M.
La versiones 1.0 y el nombre del paquete va a ser com G.M. punto ya Doc y damos pueden finalizar bien
así que ya tenemos claro nuestro proyecto y vamos a crear una primera clase sobre sus packages dentro
del paquete de com que me llama DOGC.
Vamos a crear una nueva clase llamada Aritmética así que damos derecho New seleccionamos Java class
y el nombre de la clase va a ser aritmética dejamos los demás valores por default y podemos observar
dónde se va a depositar nuestra clase de aritmética punto IAVA se va a depositar dentro del nombre del
proyecto.
Ejemplo Java DOGC.
Posteriormente las carpetas de Meilán Sors en Java y posteriormente las carpetas de nuestro paquete
com G.M Java Doc y siguen finalizar y podemos observar que el IDE en automático no se agrega ciertos
comentarios vamos a quitar estos comentarios para hacerlos nosotros mismos así que quitamos estas líneas
en nombre del paquete es con G.M IAVA DOGC.
Posteriormente se crea nuestra clase aritmética públicas aritmética y vamos a agregar un primer comentario
llamado Los comentarios en Java DOGC se abren de la siguiente manera diagonal asterisco asterisco y
se cierran con asterisco diagonal y si damos Enter de manera automática podemos observar que no cerró
nuestro comentario de Java Doc e incluso nos agregó la etiqueta de autor y el nombre del autor en este
caso Ubaldo bien voy a poner mi nombre Ubaldo Acosta en nombre del autor y voy a agregar el siguiente
comentario.
Primero agregó un enter simplemente para separar este comentario y agregó lo siguiente Esta clase permite
realizar operaciones de aritmética como sumar restar etc. Así que el objetivo de esta clase y también
voy a agregar la versión utilizó la anotación de versión y podemos observar que si utilizamos arroba
tenemos diferentes anotaciones que podemos utilizar sin embargo no todas aplican para la definición
de la clase así que más adelante vamos a ver algunas anotaciones más pero también nos vamos a dejar
un link para una referencia donde pueden revisar a detalle todas las anotaciones que podemos utilizar
con Java Doc y también pueden observar en donde van a aplicar bien así que les vamos a dejar esta referencia
para cualquier duda viene ahora como siguiente paso vamos a definir un primer atributo de nuestra clase
va a ser el tipo entero se llama operando a y normalmente los atributos no los vamos a documentar pero
es posible documentarlos no hay ningún problema.
El único detalle es que dentro de la documentación de Java DOGC no se va a mostrar esta documentación
de los atributos ya que únicamente se va a mostrar la documentación de los métodos bien así que ponemos
diagonal asterisco asterisco para abrir nuestro comentario de IAVA DOGC damos enter y ponemos el comentario.
Primer operando así que aunque no se va a visualizar en la documentación de Java DOGC es posible agregar
esta documentación para que cuando alguien revise nuestro código también pueda revisar los comentarios
asociados a los atributos.
En dado caso que así lo deseemos y vamos a agregar un segundo operando también de tipo entero llamado
operándose y después de los atributos vamos a negar a los constructores así que ponemos diagonal asterisco
asterisco para abrir nuestro comentario y ponemos el comentario constructor nació de la clase yo no
voy a utilizar caracteres especiales ya que también la documentación de Java Dog podría tener algunos
problemas para respetar los acentos o incluso letras como la ñ así que se recomienda utilizar únicamente
los caracteres que sean parte del alfabeto en inglés.
Por ello es que voy a omitir el uso de acentos bien definimos nuestro constructor va a ser un constructor
público llamado aritmética que debe ser igual al nombre de la clase.
Va a ser el constructor ovación no reciben ningún argumento y abrimos el cuerpo de nuestro constructor
en este caso tampoco va a tener ningún código simplemente es el constructor vacío y ahora vamos a definir
un método agregamos el siguiente comentario de IAVA DOGC.
Este método realiza la suma de dos operandos
enteros
y utilizamos la notación del gritón para indicar cuál es el tipo de regreso va a ser un entero y lo
que va a regresar es el resultado de la suma.
Así podemos observar que en este caso ya estamos documentando sin ningún problema el método que vamos
a agregar a continuación es un método de tipo público va a regresar un entero según ya hemos indicado
el método se llama sumar no recibe ningún argumento pero si recibiera algún argumento entonces podríamos
utilizar la notación de Parham podemos observar que podemos utilizar esta notación para indicar cuáles
son los parámetros que va a recibir este método.
Recuerden que parametro o argumento es lo mismo así que por ello podríamos utilizar la notación Parham
para indicar cuáles son los parámetros que va a recibir este método bien de momento no lo vamos a utilizar
ya que no vamos a recibir ningún parámetro y regresamos el resultado de la suma Huitrón operando a más
operando.
Y podemos utilizar el operador dis para acceder a los atributos de nuestra clase a los atributos dinámicos
y de momento va a hacer todo lo que vamos a llegar a nuestra clase y ahora vamos a agregar la clase
para poner a prueba esta clase así que sobre ejemplo Babadook vamos a dar clic derecho Niu ya da clase
y la clase se va a llamar prueba ya va DOGC y el nombre del paquete se va a llamar prueba y damos clic
en Finalizar vamos a quitar estos comentarios
y vamos a agregar un comentario a nuestro paquete.
Podemos agregar comentarios simples con Diagonal asterisco así que en este caso voy a agregar un comentario
simple este comentario no es parte de IAVA DOGC únicamente es un comentario que voy a agregar a esta
clase pero no va a aparecer como parte del resultado ya Bardock y escribimos derechos reservados en
este caso globalmente Haring punto com punto Mx eso es para que puedan ver que podemos tener comentarios
simples o comentarios de IAVA DOGC en este caso este es un comentario simple y vamos a agregar el siguiente
comentario de IAVA Doc.
Recordemos que es diagonal asterisco asterisco enter y vamos a agregar lo siguiente clase para probar
el concepto de Java DOGC.
El autor es Ubaldo pongo mi nombre Ubaldo Acosta y agregamos la anotación de versión que es la versión
1.0.
Vamos a agregar un método main así que ponemos diagonal doble asterisco y escribimos método que ejecuta
la prueba de la clase aritmética y el parámetro que va a recibir se llama Arcs y lo que significa esto
es un arreglo de tipo string de la línea de comandos y ahora agregamos nuestro método main va a ser
Públic de tipo Static no va a regresar nada.
Se llama Mayne y recibe el arreglo de cadenas así que escribimos esto.
Abrimos y cerramos corchetes.
El argumento se llama Arx y abrimos el cuerpo del método del método main y ahora agregamos el código
a nuestro método.
Simplemente vamos a crear un objeto de tipo aritmética y vamos a mandar a llamar el método sumar.
Vamos a crear en primer lugar un objeto de tipo aritmética así que vamos a tener en nuestra variable
aritmética y definimos una variable llamada Aritmética 1.
Creamos un nuevo objeto de tipo aritmética
Punto y Coma pero podemos observar que nos está marcando un error en este caso debemos de importar la
clase aritmética.
Así que damos clic sobre este mensaje para que nos importe la clase aritmética del paquete con GM Babadook
pero también vamos a hacer un cambio sobre nuestra clase aritmética.
Vamos a agregar un constructor con dos argumentos.
Ya hemos definido nuestro constructor vació y ahora vamos a llegar un constructor con dos argumentos
escribimos públic aritmética y recibimos dos argumentos el operando a y el operando de básicamente lo
que vamos a hacer es inicializar los atributos de nuestra clase con esos argumentos que estamos recibiendo
así que el valor del argumento que estamos recibiendo no asignamos al atributo de nuestra clase.
Esto lo que va a hacer este constructor este constructor nos va a permitir inicializar los valores desde
el momento de la creación del objeto.
Aritmética así que vamos a agregar el parámetro operando a
es el primer operando ya agregamos también el segundo argumento parámetro operando de
es el segundo operando bien y una vez que ya tenemos este constructor sobre nuestra clase entonces vamos
a hacer lo siguiente al momento de crear nuestro objeto aritmética le vamos a pasar los valores por
ejemplo en este caso de 3 y 2 para asignar los valores desde el momento de la creación del objeto.
Así que con esto ya vamos a tener una variable aritmética uno que apunta a un objeto de tipo aritmética
que ya contiene valores ahora vamos a definir una variable de tipo resultado de tipo entero llamada
resultado y nuestra variable aritmética aritmética 1 mandamos a llamar el método sumar y esto nos debe
de regresar el resultado de la suma.
Finalmente mandamos a imprimir este resultado ese hobby y presionamos la tecla de tabulador para que
nos mande a imprimir la variable resultado guardamos cambios y ejecutamos
y podemos ver que el resultado es igual a 5 no tenemos ningún problema 3 más dos.
El resultado nos da cinco bien ahora para terminar el objetivo de esta elección vamos a generar el Java
DOHC de este proyecto.
Para ello es muy simple ya hemos agregado todas las anotaciones a nuestra clase ya hemos documentado
nuestro código y para generar el código Java Doc simplemente damos clic derecho y seleccionamos la opción
de generate Java Doc.
Así que vamos a dar clic esperamos a que termine de descargarse todo lo necesario y al terminar se va
a generar nuestro código Java Doc
aquí estamos dando un error no trajinan after estoy utilizando alguna anotación que no le agregué el
nombre de la anotación y nos manda el error aritmética punto IAVA en la línea 8 así que vamos a la línea
8 aquí está el problema así que como podemos observar incluso para generar el DOGC debemos tener una
sintaxis correcta.
Así que con esto ya debe de estar corregido el problema de nueva cuenta gamos y derecho generated ya
Baudot si tuviéramos también algún problema con nuestro código Podemos primero dar clic derecho Cline
Anvil y ya que se genera de manera exitosa nuestro proyecto vamos a hacerlo seleccionamos Finan bio
para tener el último código nos manda que ya se ha construido exitosamente nuestro proyecto y una vez
que ya tenemos construido nuestro proyecto con la última versión damos clic derecho general Babadook
bien así que con esto ya se generará nuestro IAVA DOGC y podemos llevar todos los archivos que se han
generado
ellos son todos los archivos HTML que se han generado con el archivo de índex podemos entrar directamente
así que podemos copiar este link el link del índex abrimos un navegador y proporcionamos la ruta para
poder acceder a nuestro llamado y podemos ver el dock de nuestro proyecto ejemplo Java Doc 1.0 API.
Vemos los paquetes el paquete de con qué me llama Doc y el paquete de prueba.
Si entramos al paquete de con qué me llama Doc podemos ver la clase aritmética y observamos la documentación
que hemos agregado.
Esta clase permite realizar operaciones de aritmética como sumar restar etcétera.
Esto debido a que dentro de la clase aritmética utilizamos el comentario de Java Doc y agregamos incluso
algunas anotaciones.
No todo lo que agreguemos en Java Doc lo vamos a visualizar en el código HTML así que algunas cuestiones
solamente van a ser para el código y otras se van a visualizar de manera pública a través de esta página
HTML.
Posteriormente entramos a nuestra clase aritmética podemos observar que en automático nos muestra el
paquete.
La clase hermética que tiene de la clase ya Link Objet y también podemos ver el código públicas aritmética
extenso o bien el comentario la versión y el autor.
Aquí sí ya podemos ver otros detalles que hemos agregado como es la versión y el autor posteriormente
nos muestra el resumen de los constructores que tenemos en esta clase tenemos el constructor vació y
tenemos el constructor con dos argumentos y aquí podemos ver la descripción de cada uno de los constructores
y finalmente tenemos el resumen de los métodos en este caso tenemos únicamente el método sumar pero
cualquier otro método que tuviéramos aquí nos debe aparecer y también incluso nos muestra los métodos
heredados de la clase de la cual extendemos en este caso de la clase Java LAC o bien y posteriormente
vemos el detalle es el detalle del constructor de la clase el constructor vació y el constructor con
dos argumentos nos indica lo que va a hacer el constructor y también los parámetros que estamos recibiendo
en este constructor recibimos operando a que es el primer operando y operando que es el segundo operando.
Obviamente cualquier otra descripción que hayamos agregado se va a agregar a nuestro llamado y finalmente
tenemos el método sumar en el cual podemos observar la firma completa del método Public inhumar el comentario
de este método.
Este método realiza la suma de dos operandos enteros y lo que regresa regresa un tipo entero que va
a ser el resultado de la suma.
Así que aunque este ejercicio es muy simple podemos observar todo lo detallado que es el llamado.
Esto nos va a permitir documentar nuestros proyectos y nuestras clases sin ningún problema.
Bien ahora vamos finalmente a la clase de prueba tenemos únicamente la clase de prueba aullaba y podemos
observar la descripción entramos en la clase y de igual manera podemos observar el constructor vació
ya que como no hemos agregado ningún constructor a nuestra clase entonces en automático el compilador
agrega el constructor vacío y únicamente se ha definido el método main.
El método que ejecuta la prueba de la clase aritmética es de tipo Static Veidt se llama Main y recibe
un arreglo de cadenas como parámetro hereda de la clase Object.
Y finalmente podemos observar el detalle del constructor y del método.
En este caso el método es el único método que tenemos y tenemos un parámetro la variable harsh que es
un arreglo de tipo string que vamos a recibir desde la línea de comandos bien así que esto es todo respecto
al Java Doc de nuestro proyecto así que todo este código HTML se ha generado de manera automática y
así de esta manera ya podemos empezar a documentar también nuestras clases.
Existe todo un Java DOGC para todas las clases de Java.
Por ejemplo si abrimos en Google la versión que necesitemos por ejemplo en este caso Java Doc JDK 13
o cualquier otra versión con la cual estemos trabajando podemos observar que nos muestra el Happy para
la versión en la cual estemos trabajando y por ejemplo si queremos consultar la clase string por poner
un ejemplo buscamos la clase que necesitamos en este caso vamos a entrar a la clase destruí vamos hasta
arriba y podemos observar que estamos definiendo la clase string la cual pertenece al paquete lleva
punto Langue hereda de la clase Object y tiene todo este detalle pero básicamente esta clase es la clase
string.
Para el manejo de cadenas y aquí podemos observar todo el detalle de atributos por ejemplo estáticos
podemos observar que contiene varios constructores sobrecargados el resumen de los métodos y podemos
entrar a cualquier método de esta clase.
Para ver el detalle obviamente sin entrar al código únicamente es la documentación y así podemos ver
cada uno de los detalles de esta clase así que para cualquier duda de alguna clase que estén utilizando
les recomendamos familiarizarse con el Java Doc.
En este caso de la versión JDK que estén utilizando para que poco a poco empiecen a dominar el Java
DOGC y así puedan salir de cualquier duda más rápidamente les vamos a dejar estos links adjuntos a su
lección y eso es todo por este vídeo nos vemos en la siguiente elección.
Saludos.