Añadir comentarios a código java
Esta lista de Java tiene una versión mejorada de un programa de ejemplo. Además de todas las palabras clave, identificadores, y la puntuacion, que tiene el texto que ha significado para los seres humanos para leer.
/ ** Listado 3-6 en "Java para los maniquíes, 6ª Edición"** Derechos de autor 2014 Wiley Publishing, Inc. * Todos los derechos reservados. * // *** El Displayer clase muestra de texto * en la pantalla del ordenador. ** @author Barry Burd * @version 1.0 24/10/13 * @see java .lang.System * / public class {Displayer / *** el método principal es donde * ejecución del código comienza. ** @param args (Véase el Capítulo 11.) * void Main (args String []) / public static { System.out.println ("Me encanta Java!")- //¿YO? ¿Tú?}}UN comentario es una sección especial de texto dentro de un programa cuyo propósito es ayudar a la gente a entender el programa. Un comentario es parte de la documentación de un buen programa.
Video: 4. Programación en Java || Introducción || Comentarios en Java
El lenguaje de programación Java tiene tres tipos de comentarios:
los comentarios tradicionales: Las primeras cinco líneas de la forma: listan un tradicional comentario. El comentario empieza con / * y termina con * /. Todo entre la apertura / * y el cierre * / es sólo para los ojos humanos. No hay información acerca “Java para los maniquíes, 6ª Edición” o Wiley Publishing, Inc. se traduce por el compilador.
El segundo, tercero, cuarto, quinto y líneas del Listado 3-6 tienen asteriscos (*) adicionales. Se llaman extra porque estos asteriscos no son necesarios cuando se crea un comentario. Que acaba de hacer el comentario de mirada bonita.
los comentarios al final de la línea: El texto //¿YO? ¿Tú? en el listado es una fin de la línea comentario. Un comentario final de la línea comienza con dos barras y va al final de una línea de texto. Una vez más, el compilador no se traduce el texto dentro del comentario al final de la línea.
comentarios Javadoc: UN Javadoc comentario comienza con una barra y dos asteriscos (/ **). La lista tiene dos comentarios javadoc - uno con el texto La clase Displayer. . . y otra con el texto El método principal es donde. . . .
Video: 06.- Curso de javascript para principiantes. Añadir Comentarios al código
Un comentario Javadoc es una clase especial de comentario tradicional. Un comentario javadoc está destinado a ser leído por personas que ni siquiera mirar el código Java. Pero eso no tiene sentido. ¿Cómo se puede ver los comentarios javadoc?
Así, un cierto programa llamado Javadoc (¿Qué otra cosa?) Puede encontrar todos los comentarios Javadoc en el listado y convertir estos comentarios en una página web de aspecto agradable. Esta figura muestra la página.
comentarios Javadoc son grandes. Aquí hay varias grandes cosas acerca de ellos:
La única persona que tiene que mirar a una pieza de código Java es el programador que escribe el código. Otras personas que utilizan el código puede averiguar lo que hace el código mediante la visualización de la página web generada automáticamente.
Video: 5. JAVA: Cómo hacer comentarios en nuestro código?
Debido a que otras personas no se fijan en el código Java, otras personas no se hacen cambios en el código Java. (En otras palabras, otras personas no se introducen errores en el código Java existente.)
Debido a que otras personas no se fijan en el código Java, otras personas no tienen que descifrar los mecanismos internos del código Java. Todas estas personas necesitan saber sobre el código es lo que leen en la página web del código.
El programador no crea dos cosas separadas - un código de Java aquí y algo de documentación sobre el código de allí. En su lugar, el programador crea una pieza de código Java e incrusta la documentación (en forma de comentarios Javadoc) justo dentro del código.
Video: Agrega una Caja de Comentarios en Tu Página Web
Lo mejor de todo, la generación de páginas web de comentarios Javadoc es automático. Así que la documentación de todo el mundo tiene el mismo formato. No importa que el código Java que utilice, averiguar acerca de que el código mediante la lectura de una página como la de la figura. Eso es bueno porque el formato es familiar para cualquiera que utiliza Java.