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 puntuacion, tiene el texto que ha significado para los seres humanos para leer.

/ ** Listado 3-6 en "Java For Dummies, 6ta Edición" ** Derechos de Autor 2014 Wiley Publishing, Inc. * Todos los derechos reservados. * // *** El Displayer pantallas clase de texto * en la pantalla de ordenador. ** @ autor Barry Burd *version 1.0 24/10/13 *see java.lang.System * / clase Displayer pública {/ *** El método principal es donde * ejecución del código comienza. ** argsparam (Vea el Capítulo . 11) * / public static void main (String args []) {System.out.println ("Me encanta Java!") - // Yo? ¿Usted?}}

LA 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.

El lenguaje de programación Java tiene tres tipos de comentarios:

• Comentarios tradicionales: Las cinco primeras líneas de la forma: listan un tradicional comentar. El comentario comienza con / * y termina con * /. Todo entre la apertura / * y el cierre * / es sólo para los ojos humanos. No hay información acerca "Java For Dummies, 6ta Edición" o Wiley Publishing, Inc. es traducido por el compilador.

  El segundo tercio, cuarto y el quinto, en el Listado 6.3 tienen asteriscos extra (*). Se llaman extra porque estos asteriscos no son necesarios cuando se crea un comentario. Ellos sólo hacen el comentario mirada bonita.

• De fin de línea de comentarios: El texto //¿YO? ¿Usted? en el anuncio es un fin de la línea comentar. Un comentario final de la línea comienza con dos barras y va a la final de una línea de texto. Una vez más, el compilador no se traduce el texto dentro del comentario de fin de línea.

• Javadoc comentarios: LA javadoc comentario comienza con una barra y dos asteriscos (/ **). El perfil tiene dos comentarios javadoc - uno con el texto La clase Displayer. . . y otro con el texto El método principal es dónde. . . .

  Un comentario javadoc es un tipo 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 puedes ver los comentarios javadoc?

  Bueno, 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 el código hace mediante la visualización de la página web generada automáticamente.

• 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 el funcionamiento interno 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 - algo de código Java aquí y algo de documentación sobre el código 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.

• Lo mejor de todo, la generación de las páginas web de los 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, te enteraste 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.