Cómo utilizar los comentarios en programación java
En programación Java, hay una diferencia entre el código escrito sólo para las máquinas y el código escrito para ser leído por personas. Esta primera lista es muy simple y está destinado sólo para máquinas.
paquete de la clase org.allyourcode.myfirstproject pública MyFirstJavaClass {/ * @param args *** / public void (String [] args) {javax.swing.JOptionPane.showMessageDialog (nulo, "Hola") -}}Esta segunda lista tiene una versión mejorada del código en el primer listado. Además de todas las palabras clave, identificadores, y la puntuacion, esta segunda lista tiene texto que ha significado para los seres humanos para leer.
/ ** Listado 5-2 en * "Java para desarrolladores de Android para Dummies"** Derechos de Autor 2013 Wiley Publishing, Inc. * Todos los derechos reservados. * /org.allyourcode.myfirstproject- paquete/ *** MyFirstJavaClass muestra un cuadro de diálogo * en la pantalla del ordenador. ** @author Barry Burd * @version 1.0 02/02/13 * @see java.swing.JOptionPane * /MyFirstJavaClass public class { / *** El punto de partida de la ejecución. ** args @param * (no se utiliza). * /void main (String [] args) {public static javax.swing.JOptionPane.showMessageDialog (null, "Hola") - //¿nulo?}}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.
El lenguaje de programación Java tiene tres tipos de comentarios:
los comentarios tradicionales: Todo entre la apertura / * y el cierre * / es sólo para los ojos humanos.
Líneas 2-6 en la segunda listados tienen asteriscos adicionales (*). Son extra debido a que estos asteriscos no son necesarios cuando se crea un comentario. Sólo hacen el comentario de mirada bonita. Se incluyen en la lista, ya que, por alguna razón, la mayoría de los programadores de Java insisten en la adición de estos asteriscos adicionales.
los comentarios al final de la línea: El texto //¿nulo? en el segundo en la lista es una fin de la línea comentario - que comienza con dos barras y va al final de una línea de texto. Una vez más, el compilador no traduce el texto dentro de un comentario al final de la línea.
comentarios Javadoc: UN Javadoc comentario comienza con una barra y dos asteriscos (/ **). La segunda lista tiene dos comentarios javadoc - uno con el texto MyFirstJavaClass muestra un cuadro de diálogo. . . y otra con el texto El punto de partida. . . .
UN Javadoc comentario es un tipo especial de comentario tradicional: Está destinado a ser leído por personas que ni siquiera mirar el código Java.
Espera - que no tiene sentido. ¿Cómo se puede ver los comentarios Javadoc en el listado si nunca fijamos en el listado?
Pues bien, con algunos puntos y clics, usted puede encontrar todos los comentarios Javadoc en el segundo anuncio y convertirlos en una página web de aspecto agradable, como se muestra en la figura.
Para hacer que las páginas de documentación para su propio código, siga estos pasos:
Poner comentarios Javadoc en el código.
En el menú principal en Eclipse, seleccione Proyecto → Generar Javadoc.
Como resultado, aparece el cuadro de diálogo Javadoc Generación.
En el cuadro de diálogo Javadoc Generación, seleccione el proyecto Eclipse cuyo código desea documentar.
Aún en el cuadro de diálogo Javadoc Generación, observe el nombre de la carpeta en el campo Destino.
El equipo pone las páginas de documentación de nueva creación en esa carpeta. Si prefiere una carpeta diferente, puede cambiar el nombre de la carpeta en este campo Destino.
Haga clic en Finalizar.
Como resultado, el equipo crea las páginas de documentación.
Si visita la carpeta de destino y haga doble clic en el nuevo index.html el icono del archivo, ver sus hermosas (e informativos) páginas de documentación.
Puede encontrar las páginas de documentación para las clases de API incorporadas de Java visitando el sitio web de Oracle Documentación de Java SE de un vistazo página. API de Java contiene miles de clases, por lo que no memorizar los nombres de las clases y sus métodos. En su lugar, sólo tiene que visitar estas páginas de documentación en línea.