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.
Para hacer que las páginas de documentación para su propio código, siga estos pasos:
Ponga comentarios Javadoc en el código.
En el menú principal de Eclipse, seleccione Proyecto-Genera 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.
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.
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 usar javadoc para documentar sus clases Un paso permanece antes de poder salir a bolsa con su biblioteca de clases nuevo caliente o aplicación: la preparación de la documentación para sus clases. Afortunadamente, Java proporciona una herramienta llamada JavaDoc que puede crear…
Cómo escribir código Java para mostrar una imagen en la pantalla Es probable que encuentre momentos en programación con Java que usted necesita para mostrar una ventana en la pantalla del ordenador. Este código tiene muy poca lógica propia. En su lugar, el código reúne un montón de clases de la API de…
Java: la creación de nuevas anotaciones Usted ha visto los comentarios utilizados en muchos ejemplos de código Java. El compilador ignora los comentarios, por lo que cuando se crea un comentario que puede escribir cualquier cosa que usted se siente será útil más adelante en averiguar…
Palabras clave de Java y los identificadores El lenguaje Java utiliza dos tipos de palabras: las palabras clave y los identificadores. Se puede decir que las palabras son palabras clave, porque Java solamente 50 de ellos tiene. Aquí está la lista…
Java: utilizando anotaciones predefinidas Los tipos y el contenido de las anotaciones en Java, como comentarios, sólo están limitadas por su imaginación. Sí, Java proporciona algunas anotaciones predefinidas, pero también puede crear anotaciones que describen los elementos del programa…
Operadores lógicos de Java Java tiene todos los operadores que usted necesita para mezclar y combinar las pruebas lógicas. Los operadores se muestran en esta tabla. Echa un vistazo a cada símbolo del operador, su significado, y un ejemplo.Operadores lógicosSímbolo del…
Dar sentido a la documentación de la API de Java Érase una vez, las personas juzgadas lenguajes de programación (como Java) únicamente por sus características gramaticales. ¿Un si Declaración de hacer lo que usted espera que haga? Están bucle declaraciones fáciles de usar? Son métodos…
Declaración de método y el método de llamada en programación Java Casi cada lenguaje de programación tiene elementos similares a los métodos de Java. Si usted ha trabajado con otros idiomas, se recordará términos como subprograma, procedimiento, función, subrutina, subprocedimiento, o REALICE declaración. Lo…
Paquetes y declaraciones de importación en java Java tiene una característica que le permite a tanto alzado clases en grupos de clases. Cada trozo de clases se denomina paquete. En el mundo Java, los programadores habitualmente dan estos paquetes nombres largos, punto lleno.Por ejemplo, porque…
El archivo r.java directorio gen El nombre del directorio gen representa gennerada. los gen directorio contiene R.java. Este listado muestra esa parte de la R.java archivo generado para usted cuando se crea un proyecto nuevo./ * AUTO-GENERADO ARCHIVO. NO MODIFIQUE. ** Esta clase…
Eclipse para dummies Una vez que hayas instalado Eclipse, tomar ventaja de todas las características para mejorar el IDE (entorno de desarrollo integrado) y crear aplicaciones Java eficaces. Echa un vistazo a todas las cosas que puede hacer:Crear un proyecto: Elija…
Tratar con los comentarios javadoc en Eclipse Al utilizar Eclipse para escribir código Java, no se olvide de editar los comentarios Javadoc (las cosas que comienzan con / **). Usted puede agregar información útil al editar los comentarios Javadoc, y a medida que los edita, código de Eclipse…