Codificación aprenderaprogramar.com: CU00910C
DOCUMENTACIÓN
Como siempre ante cualquier aprendizaje de cualquier lenguaje, es necesario saber cómo consultar la documentación del lenguaje, ya que ésta nos facilita su comprensión y además nos permite un aprendizaje más rápido del mismo. En nuestro caso veremos a continuación como descargar e instalar la documentación de las clases del api de Java (que recordamos son las clases principales que utilizaremos cuando programemos en el lenguaje Java) para disponer de ella en nuestro ordenador en local.
La documentación del API de Java se puede consultar de distintas maneras: en un libro, en internet, en nuestro ordenador si tenemos una copia en local… Nosotros vamos a exponer cómo instalarnos la documentación en local. Algunos programdores prefieren descargar e instalar la documentación del API en su ordenador porque así no se necesita internet para consultar la documentación. De este modo, muchas veces es posible programar más rápido porque los tiempos de respuesta son casi inmediatos cuando trabajamos sin necesidad de navegar por internet para consultar la documentación.
¿Es mejor tener la documentación del API Java en nuestro ordenador o consultarla en internet? Todo tiene sus ventajas e inconvenientes, por lo que no vamos a decir que claramente sea mejor una cosa u otra. Como decimos, muchos programadores trabajan con la documentación en local porque es más rápido y no requiere de internet, mientras que otros no le dan relevancia a esto.
DESCARGA DE LA DOCUMENTACIÓN
Para proceder a la descarga de la documentación debemos acceder con un navegador a la página oficial de Java, que pertenece a Oracle: http://www.oracle.com/technetwork/java/javase/downloads/index.html. La visualización será similar a esta (aunque el aspecto va cambiando cada pocos meses, los contenidos son fáciles de encontrar):
Una vez aquí deberemos buscar la documentación de la versión correspondiente a la versión que estemos usando (Java SE X Documentation, donde X es el número de versión). Supongamos que estamos trabajando con Java SE 9 (comprueba en tu caso qué versión estás usando). En este caso nos vamos a descargar la documentación para la versión que usemos, buscamos Documentation download y hacemos clic con el ratón en el botón “Download”.
Entonces nos saldrá una pantalla previa para aceptar las condiciones y una vez aceptadas ya podemos pinchar en el enlace de descarga del tipo jdk-9u91-docs-all.zip. Es un archivo que puede superar a los 100 MB de peso, por lo que debes de tener una buena conexión a internet para poder descargarlo.
Una vez pinchado para descargar, recomendamos seleccionar el directorio c:\Archivos de Programa\Java como ubicación para la descarga.
INSTALACIÓN
Una vez terminada la descarga pasaremos a descomprimir el archivo. Dentro del archivo comprimido encontraremos una carpeta llamada “docs”. Esta carpeta debemos copiarla dentro de una ruta que será similar a C:\Archivos de programa\Java\jdk1.9.0_94 donde jdk1.9.0_94 indica la versión de Java. Si utilizamos otra versión (por ejemplo jdk1.8.0_18) deberemos de introducirlo dentro del directorio correspondiente.
Una vez realizados estos pasos podremos crear un enlace directo o link en nuestro escritorio que nos permita acceder directamente a la documentación que tenemos en el directorio donde esté la carpeta docs con la documentación descargada. Así el enlace directo apuntará a una ruta de este tipo: C:\Archivos de programa\Java\jdk1.9.0_94\docs\api\index.html
Para crear un enlace directo en Windows basta con posicionar el ratón sobre el escritorio, pulsar botón derecho y elegir “Nuevo -- > Acceso directo”. Una vez nos pida “Escribir la ubicación del elemento:”, escribimos la ruta o la seleccionamos, de forma que ya tendremos el acceso desde el escritorio que nos permitirá abrir el archivo html raíz de la documentación.
Al hacer doble clic sobre el enlace directo, accederemos a una página de inicio de la documentación pero en local (es decir en el ordenador donde estamos trabajando), con una apariencia similar a esta (variará dependiendo de la versión que estemos utilizando).
En la zona que hemos marcado en color rojo tendremos un listado conteniendo todos los paquetes definidos en la documentación. Así por ejemplo podemos ver el paquete java.lang, o el paquete java.util que hasta ahora hemos utilizado un poco en los ejercicios de repaso cuando escribíamos un “import”.
En la zona verde veremos las interfaces, clases, excepciones, errores, etc… correspondientes al paquete seleccionado en la zona roja. (Hablaremos de excepciones y de errores más adelante en posteriores epígrafes, pero al menos ya sabemos dónde podemos consultar).
Por último en la zona amarilla podemos navegar y obtener una descripción tanto de paquetes, como de clases así como de las propiedades, constructores, métodos que quedan definidos en una determinada clase junto con sus descripciones.
Una pequeña pega puede ser que toda la documentación está en ingles, pero como programadores debemos habituarnos a que la mayor parte de la documentación se encuentra en inglés. En general no es difícil de seguir. En caso de ser necesario, podemos usar la herramienta de traducción automática de google. Para más información sobre esta herramienta puedes consultar la dirección web:
VENTAJAS E INCONVENIENTES DE TENER LA DOCUMENTACIÓN EN LOCAL
Ya hemos citado que las ventajas de tener la documentación en local son el acceso muy rápido y el no depender de internet.
Como inconvenientes, tendríamos el estar ocupando un espacio de disco duro que no ocuparíamos si realizamos las consultas a través de internet.
Nuestra recomendación: si internet te va muy bien no es necesario que tengas la documentación en local. Si internet te falla o es lento, puede ser preferible que instales la documentación en local.
Para acceder a la información general sobre este curso y al listado completo de entregas pulsa en este link: Ver curso completo.