¿Cómo se escribe un comentario de Javadoc??
Sintaxis
En primer lugar, necesitamos ver la sintaxis básica de los comentarios de Javadoc en Java. Entonces, hemos estado utilizando el editor simple para poner algunos comentarios de Javadoc y mostrar la presentación de él a continuación en la imagen adjunta. El comentario autogenerado del documento Java comienza con un personaje especial como un asterisco, y la primera línea de todo el comentario podría ser de color verde. Puede ver la representación de un comentario de documento de Java que tiene muchos personajes de asterisco al comienzo de cada comentario de principio a fin.
Al principio, el comentario de Java Doc comienza con el personaje "/" seguido de dos personajes de Asterisk. Al mismo tiempo, todas las otras líneas contienen un solo carácter de asterisco en su inicio. Al final de un comentario de documento de Java, lo hemos terminado con el personaje "/". Entre esta ilustración de comentarios de documento de Java, verá una línea de comentarios "7" donde hemos definido el nombre de un autor usando el carácter "@" para definir una variable "Autor" con el nombre de un autor de comentario, I.mi., Saeed Raza. La información de los meta-data de los comentarios del documento de Java siempre debe escribirse con el personaje "@".
Crear comentario automático de Doc Java en Eclipse IDE
Este ejemplo utiliza el entorno de desarrollo Java Eclipse IDE para crear comentarios automáticos en el proyecto Java. Para esto, debe tener un IDE Eclipse montado y configurado al final. Entonces, inicie el Eclipse IDE e intente crear un nuevo proyecto llamado "Java". Le pedirá que nombre el paquete actual del proyecto. También lo llamamos "Java". Después de eso, debe crear un nuevo archivo Java o crear una nueva clase dentro del mismo proyecto Java. Para esto, la punta derecha en el nombre del paquete desde la esquina izquierda de la barra Eclipse IDE Project Explorer Bar, muévase a la opción "nueva" y presione la palabra clave "clase" desde las opciones ampliadas. Esto generará una nueva ventana en su pantalla con el título "Nueva clase Java", como se muestra en la imagen a continuación.
Ahora, debe insertar el nombre de una clase que se creará dentro del cuadro de texto frente a la etiqueta "Nombre". La mayoría de las cosas se dejarán sin cambios, ya que estas se seleccionaron automáticamente cada vez que intente crear una nueva clase. Solo necesita borrar el método final que desea crear para su código Java. Por lo tanto, hemos marcado la primera casilla de verificación para crear una función de controlador principal () en esta clase. Por último, pero no menos importante, encontrará la oportunidad de agregar los comentarios predeterminados en el programa Java que se crean. Solo necesita marcar la casilla de verificación llamada "Generar comentarios". Este va a ser un paso fenomenal en la creación del código Java. Presionemos el botón "Finalizar" después de proporcionar toda la información necesaria.
El programa Java de Below Shows se creó en la herramienta Eclipse IDE junto con comentarios automáticos. Puedes ver que los comentarios de Java Doc comenzaron con los personajes de Asterisk. También proporciona información de metadatos sobre el proyecto, yo.mi., el autor. Junto con eso, también muestra que el comentario automático muestra que también hemos creado una función principal. Eso se trata de la generación automática de comentarios de Javadoc en Eclipse IDE.
Ejemplo 01: Comentarios de Javadoc
Ahora, puede crear sus propios comentarios de documentos de Java mientras codifica. Aquí hay otra ilustración para hacer eso. Siempre que haya estado utilizando la función del controlador Main () en el código, yo.mi., Debería haberlo estado utilizando en cada programa, siempre debe crear su comentario en la parte superior del archivo o, dentro de esta función, comenzar como "// TODO Auto Generated Method Stub". Este comentario explica que el método main () se ha generado automáticamente, yo.mi., No necesitas escribirlo.
Después de esto, hemos agregado un comentario de Javadoc que elabora sobre el uso de este programa junto con su información de metadatos, I.mi., autor, versión y la fecha en que se creó. Antes de la declaración "println", hay una sola línea de comentarios utilizados para explicar el propósito de usar la función println (). Eso es todo para este ejemplo.
La ejecución de programas con comentarios no afecta la salida como se muestra a continuación.
Ejemplo 01: Comentarios de una sola línea y multilínea
Después de pasar por los comentarios de Javadoc en Eclipse IDE, comencemos a echar un vistazo a otro ejemplo de Java utilizando los comentarios de una sola línea y de múltiples líneas, I.mi., usuario definido. Ahora generamos una nueva clase "prueba" e incluimos el método main () en él. Este método contiene una instrucción de función println () para mostrar algo. Hemos utilizado un comentario de una sola línea con el nombre de una clase que comienza con los personajes "//", yo.mi., explica que es inicialización de clase. En la línea de definición de función main () agregó un comentario de múltiples líneas que comienza con los caracteres "/*" y terminan con los caracteres "*/".
Conclusión
Este artículo lo ayuda a comprender la importancia y la vitalidad de los comentarios utilizados en la vida diaria y la vida. Discute cómo estos comentarios pueden ayudarlo de muchas maneras. En primer lugar, discutimos cuáles son los comentarios de Javadoc y explicamos su sintaxis muy brevemente. Después de esto, explicamos todo el método en Eclipse IDE para generar los comentarios automáticos de Javadoc en unos pocos segundos y con unos pocos clics en la GUI.