Cómo utilizar los comentarios en programación de java

En la 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. Este primer listado es muy sencillo y está destinado sólo para máquinas.

paquete org.allyourcode.myfirstproject pública clase MyFirstJavaClass {/ *** argsparam principales (String [] args) static void * / {públicas javax.swing.JOptionPane.showMessageDialog (null, "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 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. * /paquete org.allyourcode.myfirstproject-/ *** MyFirstJavaClass muestra un cuadro de diálogo * en la pantalla de ordenador. **author Barry Burd *version 1.0 02/02/13 *see java.swing.JOptionPane * /public class MyFirstJavaClass { / *** El punto de partida de la ejecución. ** Argsparam * (No utilizado.) * /main (String [] args) public static void {javax.swing.JOptionPane.showMessageDialog (null, "Hola") - //¿nulo?}}

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: Todo entre la apertura / * y el cierre * / es sólo para los ojos humanos.

    Líneas 2-6 en la segunda lista tienen asteriscos adicionales (*). Ellos son extra porque estos asteriscos no son necesarios cuando se crea un comentario. Ellos sólo hacen el comentario 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.


  • De fin de línea de comentarios: El texto //¿nulo? en la segunda lista es un fin de la línea comentarios - que 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 de un comentario al final de la línea.

  • Javadoc comentarios: LA 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 otro con el texto El punto de partida. . . .

    LA 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 puedes ver los comentarios javadoc en el listado si nunca fijamos en la lista?

    Bueno, 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.

    imagen0.jpg

Para hacer que las páginas de documentación para su propio código, siga estos pasos:

  1. Ponga comentarios Javadoc en el código.

  2. En el menú principal de Eclipse, seleccione Proyecto-Genera Javadoc.


    Como resultado, aparece el cuadro de diálogo Javadoc Generación.

  3. En el cuadro de diálogo Javadoc Generación, seleccione el proyecto Eclipse cuyo código desea documentar.

  4. Todavía 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.

  5. Haga clic en Finalizar.

    Como resultado, el equipo crea las páginas de documentación.

Si usted visita la carpeta de destino y haga doble clic en el nuevo index.html icono de archivo, ver sus hermosas páginas (e informativos) de documentación.

Usted puede encontrar las páginas de documentación para las clases de API incorporadas de Java visitando Java SE Documentación de la página web de Oracle en una página Vistazo. API de Java contiene miles de clases, así que no memorizar los nombres de las clases y sus métodos. En lugar de ello, sólo tiene que visitar estas páginas de documentación en línea.




» » » » Cómo utilizar los comentarios en programación de java