Dar sentido a la documentación de la api de java

Hace mucho tiempo, las personas juzgadas lenguajes de programación (como Java) únicamente por sus características gramaticales. ¿un Si declaración Haz lo que espera que haga? Son declaraciones de bucle fácil de usar? Son métodos implementados de manera eficiente?

Hoy en día, las cosas son un poco diferentes. Java tiene toda una colección de rasgos gramaticales, pero Java es mucho más que un gran conjunto de reglas gramaticales. Java tiene un estándar ApplInterfaz de programación icación -a enorme biblioteca consta de más de 4000 clases, cada uno con su propia funcionalidad, sus propias limitaciones, y sus propias reglas de uso eficaz.

La búsqueda de un término

Puede encontrar cosas en la documentación de la API en un número de maneras diferentes. Cada forma es conveniente en una u otra situación. Por ejemplo, Java tiene un método denominado System.out.println. Lo que sigue describe dos maneras de ver el System.out.println método.

Video: Buscar caracter en una cadena con Java/Netbeans por Carlos Escobar

Utilizando el índice

Aquí es cómo encontrar algo, como System.out.println, utilizando el índice:

1. Visitar docs.oracle.com/javase/8/docs/api/.

2. Haga clic en el enlace de índice en la parte superior de la página para abrir el índice, como se muestra en la Figura 1.

   
   Figura 1: la página principal de la documentación de la API.

   Una lista de letras está cerca de la parte superior del índice (véase la Figura 2). Haga clic en el enlace P para ir a la sección con println en eso.

   Figura 2: página de índice de la documentación de la API.

3. En la sección P, hacer una búsqueda de println para encontrar la println entradas.

   La mayoría de los navegadores web que permiten a buscar algo así como println en el texto de una página. Así es cómo:

1. Asegúrese de que el navegador sabe que desea buscar en el gran marco que ocupa la mayor parte de la página (y no en los marcos más pequeños en la parte izquierda de la página). Para ello, haga clic en el puntero del ratón dentro del marco grande. (No haga clic en un enlace. Haga clic en un área blanco neutro del marco.)

2. Abrir el cuadro de diálogo de búsqueda del navegador. En la mayoría de los navegadores de Windows, al pulsar Ctrl + F engatusa el cuadro de diálogo de búsqueda de su escondite. En un Mac, al hacer clic Comando + F hace el truco.

3. Cuando vea el cuadro de diálogo Buscar, escriba println en el cuadro de texto y haga clic en Buscar de la caja o botón Buscar siguiente.

Cada entrada que dice println es un método en la clase Java.someStuff.someMoreStuff. La clase puede diferir de una entrada a otra.

entradas println en el índice de la documentación de la API “/ GT.;

Figura 3: Un poco println entradas en el índice de la documentación de la API.

En este punto, vale la pena hurgar. Si usted está tratando de imprimir algo así como "¡Hola Mundo!", quieres una de las println (String) entradas. Por otro lado, si usted está tratando de imprimir el valor de LengthOfStraightLine, es probable que elija una println (doble) entrada.

Ahora, supongamos que usted ha decidido sobre println (String). Se puede elegir entre tres println (String) entradas. Se dice que es un método en la clase java.io.PrintStream, el siguiente es un método en la clase java.io.PrintWriter,y el tercero es un método en la clase java.sql.DriverManager. ¿Cuál de estas tres entradas a elegir?

Pues bien, lo que realmente está tratando de llamar es algo named System.out.println. Si usted va a través de todo el galimatías de búsqueda con SystemOut, usted encontrará que system.out tiene el tipo PrintStream. (Véase la Figura 4, a continuación.) Así que la println (String) la entrada de decidirse a elegir es

println (String) - Método de la clase java.io.PrintStream.

cabo variable tiene el tipo PrintStream.“/>

Haga clic en el enlace de la entrada que usted ha elegido.

Al hacer clic en el enlace println (String), el navegador te lleva a una página que explica una println método, como se muestra en la Figura 5. La página que dice lo println no ( “imprimir una cadena y luego....”) y apunta a otras páginas de interés, como la página con la documentación Cuerda.

método println “/ GT.;

Figura 5: Una descripción de la println método.

Usando la lista de clases

Aquí es cómo encontrar una entrada en el API a partir de la lista de clases:

1. Visitar docs.oracle.com/javase/8/docs/api/.

2. Encontrar la página que documenta la Sistema clase.

   Video: Documentacion en Java Utilizando Javadoc by Henry Mendez

   Usted está buscando documentación que explica System.out.println. Así que mira hacia arriba Sistema, su forma de trabajo a fuera, y desde allí, su forma de trabajo a println.

   Para encontrar un enlace a Sistema, mirarse en el marco inferior en el lado izquierdo de la página. (Véase la Figura 6.) Para consejos sobre cómo encontrar texto en la página, véase el paso 3 en la sección “Uso del índice”.

   clase System “. />
   Figura 6: Encontrar un enlace a la Sistema clase.

   Al hacer clic en el enlace Sistema hace que el navegador muestre la página de documentación para la Sistema clase, como se muestra en la Figura 7.

   la documentación del sistema de clase “/ GT.;
   Figura 7: La Sistema la documentación de la clase.

3. En la página de documentación de la Sistema clase, encontrar el fuera variable.

   Si utiliza cuadro de diálogo de búsqueda de su navegador web, usted tiene que hacer clic en el botón Buscar siguiente varias veces. (El nombre fuera es tan común, que aparece varias veces en varios contextos diferentes en el Sistema página de documentación.) Cuando haya encontrado lo que busca, verá una tabla como la que se muestra en la Figura 4, arriba.

4. En la tabla de fuera fila, haga clic en el enlace PrintStream.

   De acuerdo con la documentación, el fuera variable se refiere a un objeto de tipo PrintStream. Esto significa que println es parte del PrintStream clase. Es por eso que estás haciendo clic en el PrintStream enlazar.

5. En la página de documentación de PrintStream, encontrar println (String).

   Ves una explicación como la que se muestra en la Figura 5, anteriormente.

Puedes hacerlo también

Después de seguir los pasos de este artículo, usted puede estar tentado a decir: “Gran cosa! puedo encontrar println en los documentos de la API, pero probablemente no puedo encontrar nada más. Y si la gente a crear documentación para la materia que programar por su cuenta, a continuación, su documentación no parecerse a la documentación de la API estándar. Voy a ser de hasta un arroyo “.

La respuesta adecuada a tal objeción es “sin sentido! ¡Camelo! ¡Disparates! Plumas de caballo “He aquí por qué:

• La mayoría de los trucos que necesita para encontrar cosas en la documentación estándar de Java se ilustran en las instrucciones paso a paso de este artículo. Si usted puede encontrar System.out.println, también se puede encontrar javax.swing.JButton o cualquiera de los 4.200 programas en la API estándar de Java.

  Y, a medida que descubre más sobre Java y las relaciones entre las clases, métodos y variables, instrucciones paso a paso de este artículo se sentirán mucho más natural.

• En cuanto a la lectura de la documentación de otras personas, puede rayar ese problema derecha de su lista. Los documentos de la API estándar no han sido escritos a mano. Ellos fueron generados automáticamente de código del programa Java. Por ejemplo, el código para PrintStream.java tiene unas líneas que parecen algo como esto:

  Video: 04.- Curso de Java para Principiantes. Variables: Almacenar información

  / *** imprimir una cadena y luego terminar la línea. * Este método se comporta como si se invoca *{#print @link (String)}*y entonces {#println @link ()}.** @ PARAM x El Cuerda a imprimir. * /

  Para crear la documentación de la API, los jefes de Java a cabo un programa llamado Javadoc. El programa javadoc tomó como estas líneas a la derecha de la PrintStream.java presentar y utilizado las líneas para hacer la documentación que se ve en su navegador web.

  Otros programadores de Java hacen lo mismo. De hecho, todo el mundo que escribe código Java utiliza el programa javadoc para generar la documentación. Así documentación de Java de todo el mundo se parece a la documentación de Java de todos los demás. Cuando se sabe cómo leer la documentación API estándar, usted sabe cómo leer documentos de cosecha propia de Java de nadie.

  Y sí, puede utilizar el programa javadoc para crear su propia documentación. Al descargar el JDK, se obtiene el programa javadoc como parte del trato.