Sesión 4 (Materiales y Vídeos)

- Comentarios (JavaDoc) 

- Documentar un proyecto es algo fundamental de cara a su futuro mantenimiento. Cuando  programamos una clase, debemos generar documentación lo suficientemente detallada sobre ella como para que otros programadores sean capaces de usarla sólo con su interfaz.  Sin necesidad de leer o estudiar su implementación.

Javadoc es una utilidad de Oracle para la generación de documentación de APIs en formato HTML y otros formatos a partir de código fuente Java.

BlueJ también utiliza javadoc y permite la generación automática de documentación, y visionarla bien de forma completa para todas las clases de un proyecto, o bien de forma particular para una de las clases de un proyecto.

Recomendación al documentar una clase:

 a) Nombre de la clase, descripción general, número de versión, nombre de autores.

 b) Documentación de cada constructor o método.

 c) En BlueJ disponemos de la opción del menú Tools --> Project Documentation, que nos abre la documentación del proyecto en un navegador web. Para ver la documentación de una clase específica en BlueJ, debemos abrir la ventana de código, y en la parte superior derecha cambiar la pestaña que pone “Source code” por la opción “Documentation”. Además de documentar las clases, todo proyecto debería tener un archivo Leeme o Readme. En BlueJ podemos acceder al readme.txt de proyecto haciendo doble click en el icono que representa una hoja en la parte superior izquierda del diagrama de clases. En el readme.txt sería adecuado incluir al menos: título del proyecto, descripción, versión, cómo arrancar el proyecto, autores e instrucciones para los usuarios. 

Para que javadoc sea capaz de generar documentación automáticamente han de seguirse estas reglas:

a) La documentación para javadoc ha de incluirse entre símbolos de comentario que han de empezar con una barra y doble asterisco, y terminar con un asterisco y barra simple.

/**  * Esto es un comentario para javadoc   */

 

b) La ubicación le define a javadoc qué representa el comentario: si está incluido justo antes de la declaración de clase se considerará un comentario de clase, y si está incluido justo antes de la signatura de un constructor o método se considerará un comentario de ese constructor o método.

c) Para alimentar javadoc se usan ciertas palabras reservadas (tags) precedidas por el carácter "@", dentro de los símbolos de comentario javadoc. Si no existe al menos una línea que comience con @ no se reconocerá el comentario para la documentación de la clase.

Ejemplo de palabras reservadas:

   @author (Nombre autor/es)

   @param (Nombre de parámetro y descripción)

   @return (Descripción del valor de retorno)

   @versión (Número de versión)

Las etiquetas @author y @version se usan para documentar clases e interfaces. Por tanto no son válidas en cabecera de constructores ni métodos. La etiqueta @param se usa para documentar constructores y métodos. La etiqueta @return se usa solo en métodos de tipo función.

 

Vídeo de Comentarios (JavaDoc) 

- Diferentes ficheros que se generan. 

Los archivos .java contienen el código fuente (entendible por humanos) que en un momento dado podemos modificar con un editor de textos y suelen encontrarse en carpetas de nombre src (source). Los archivos .class contienen el bytecode (no entendible por humanos pero sí por la máquina virtual Java) y suelen encontrarse en carpetas de nombre bin (binary).

La organización de los archivos en carpetas y la presencia de otros adicionales depende del entorno de desarrollo que utilicemos. Además, Java introduce un esquema organizativo a través de paquetes (packages) que comentaremos más adelante.
Para trabajar con proyectos en la mayoría de entornos, incluido BlueJ, debemos tenerlos en un soporte grabable accesible (por ejemplo en una carpeta de nuestro disco duro). No es válido por tanto un cd, dvd, unidad remota restringida o carpeta del disco duro con restricciones. El motivo es que los entornos de desarrollo trabajan grabando información en la carpeta del proyecto que se encuentre activo. Por tanto un soporte no escribible no es adecuado. Si queremos trabajar con un proyecto contenido en un cd o dvd, primero lo copiaremos a nuestro disco duro y después lo abriremos para trabajar con él.
Vamos a crear nuestro primer proyecto. Para ello conviene crear primero una carpeta donde ir almacenando los proyectos que vayamos creando. Hazlo en la ruta que te parezca más adecuada.
los archivos de los que consta nuestro proyecto:
· Ejemplo.java: el código fuente en lenguaje Java.
· Ejemplo.class: el bytecode o código máquina para la máquina virtual Java.
· Otros archivos: archivos creados por BlueJ a los que de momento no vamos a prestar atención.
Pulsa ahora sobre el icono del archivo Ejemplo.java y con el botón derecho del ratón elige “Abrir” para verlo con un editor de texto como el bloc de notas. Al abrirse el archivo podrás ver el código fuente (e incluso podríamos cambiarlo desde aquí si quisiéramos). Cierra el editor y trata de repetir el proceso con el icono del archivo Ejemplo.class. El resultado será que Windows te indica que no sabe cómo abrir ese archivo, o, si logras abrirlo, que te aparezcan una serie de caracteres “raros”. Esto concuerda con lo que habíamos dicho: el código fuente está constituido por texto y podemos verlo y editarlo. El bytecode es un tipo de código máquina, por tanto no podemos editarlo directamente porque no es comprensible para nosotros.
Ya hemos visto que el archivo Pieza.java contiene un código. Esa es la razón por la que nos ha sido posible compilar anteriormente usando BlueJ. Vuelve a BlueJ y para acceder al código que se encuentra en la clase hacemos doble click en el icono, con lo cual se nos abrirá la ventana del editor de BlueJ.

Vídeo de Diferentes Ficheros que se generan. 

- Compilación desde el CMD. 

Las aplicaciones a los usuarios finales, son ejecutadas de diferentes maneras.  Las aplicaciones tienen un solo punto de comienzo.  

En Java cuando se inicia un programa Java, el nombre de la clase se especifica como un parámetro del comando inicio.

Ejemplo java Pieza

El comando java inicia la máquina virtual de Java y luego buscará un método main que tenga la siguiente sintaxis:

    public static void main(String[ ] args)

Para compilar el código fuente Java se usa el compilador de Java, el compilador de Java es un programa que a partir del código fuente genera archivos de bytecode, el programa y comando del compilador de Java es javac.

Con el parámetro -classpath se indica la ubicación de las librerías o dependencias que requiriere el código fuente, con el parámetro -sourcepath el directorio raíz de los archivos de código fuente, el parámetro -source indica la versión del lenguaje del código fuente, -target la versión de la máquina virtual del bytecode que generará el compilador y con el parámetro -d el directorio donde generan los archivos class con el bytecode.

1 2 3

#!/usr/bin/env bash javac -classpath "libraries/*" -sourcepath src/main/java -source 1.8 -target 1.8 -d target/classes cp -r src/main/resources/* target/classes

Una vez generados los archivos de bytecode a partir de la compilación del código fuente su ejecución se realiza con el comando java donde hay que indicar las ubicaciones del los archivos class y las librerías jar necesarias que necesiten, la clase principal con el punto de entrada del programa que contenga un método public static void main(String[] args) y los parámetros del programa que se reciben en el parámetro args del método main. En la ejecución del programa la máquina virtual de Java interpreta el bytecode que consiste en traducir a código máquina ejecutable por el procesador del sistema anfitrión.

La compilación e interpretación de este pequeño programa Java. Lo haremos usando la ventana consola del DOS. Para visualizar esta ventana debemos proceder así: Inicio -> Todos los programas -> Accesorios -> Símbolo del sistema. Sobre la ventana consola escribiremos el comando “cd [Dirección donde tenemos los ficheros]” y pulsaremos enter.
Esto nos traslada a la carpeta donde se ubica nuestro archivo (“Pieza.java”).  A continuación daremos la instrucción para que se realice el proceso de compilación del programa, para lo que escribiremos “javac Pieza.java”, donde “javac” es el nombre del compilador (javac.exe) que transformará el programa que hemos escrito nosotros en lenguaje Java al lenguaje de la máquina virtual Java (bytecode), dando como resultado un nuevo archivo “Pieza.class” que se creará en este mismo directorio. Si te aparece un mensaje de error revisa todos los pasos anteriores que hemos explicado, pues es posible que no se hayan creado las variables de entorno o que el archivo no esté bien ubicado, etc. Para comprobar si se ha creado el archivo escribiremos en la ventana consola el comando “dir”. Comprobaremos que nos aparecen dos archivos: Pieza.class (bytecode creado por el compilador) y Pieza.java (código fuente creado por nosotros).
Finalmente, vamos a pedirle al intérprete que ejecute el programa, es decir, que transforme el código de la máquina virtual Java en código máquina interpretable por nuestro ordenador y lo ejecute. Para ello escribiremos en la ventana consola: java Pieza.

Vídeo de Compilación desde el CMD. 

Nota: Configurar la Variable Java HOME

JAVA_HOME, es una variable de entorno del sistema que informa al sistema operativo sobre la ruta donde se encuentra instalado Java. Seguiremos la siguiente secuencia de pasos para configurar esta variable:

Abrimos el explorador de Windows o pulsamos sobre “Mi Pc”. Pulsamos sobre Equipo y con botón derecho del ratón o buscando el icono -> Propiedades -> Configuración avanzada / Cambiar configuración -> Opciones avanzadas -> Variables de entorno -> Nueva (Variables del sistema).

Pueden exisitir diferencias dependiendo de la versión del Sistema Operativo instalado.

- Activídad 4 

Fecha tope el día 16 de marzo de 2026 a las 23:59 horas.

Por correo electrónico a: luis.vazquez@lugo.uned.es

Aprovechando el trabajo realizado en la actividad 3, vamos a añadirle el método main() para su funcionamiento desde el CMD del ordenador, independientemente del entorno BlueJ.

Ejercicio de Programación Java Pieza de Repuesto.

Supongamos que vamos a programar una aplicación básica para una empresa de recambios del automóvil.

Esta aplicación necesitará controlas las características que definen una PIEZA y que vendrán dada por la clase PIEZA.

La clase Pieza tiene las siguientes propiedades:

"Nombre": Cadena de texto que indica el nombre de la Pieza.

"Marca": Cadena de texto que indica la marca de vehículos para el que vale. (suponemos que solo sirve para una marca).

"Precio": Número con decimales que indica el precio en Euros.

- Constructor programe un constructor que reciba como parámetro un nombre, marca y precio y los asigne a cada propiedad.

- Métodos get y set

Programe métodos set y get para cada propiedad.

- Método toString Programe el método toString de forma que devuelva una cadena con todas las características de la pieza. 

- Método Main().  Para probar las diferentes funcionalidades programadas anteriormente desde el CMD de Windows.

Vídeo de la Actividad 4 

Ejemplo de Código Java para Actividad 4

En el asunto del correo indicar: Actividad 4 y Nombre y Apellidos

Adjuntar los ficheros.java creados para resolver el problema planteado "Fichero.java"

Breve Manual de MS-DOS

Cambiar de unidad

El símbolo C:\> indica que la unidad activa es la C:, es decir, el disco duro, y que el DOS esta preparado para recibir órdenes que damos desde el teclado.

Podemos cambiar de unidad por defecto (la C:) a otra simplemente escribiendo su letra seguida de dos puntos. Para los que no recuerdan que es eso de las letras y las unidades, les puedo refrescar la memoria diciéndoles que cada unidad de disco del ordenador tiene asignada una letra diferente (de la A a la Z). La C: para el primer disco duro, si tenemos otro, este hereda la letra D:

Visualizar el contenido de una unidad de disco

De la misma forma que un libro o revista tiene un índice, los discos también tienen, evidentemente de una forma diferente, pero con la misma finalidad, informar de un vistazo el contenido del mismo.

La función es sencilla, utiliza DIR para listar archivos.

NOTA: Sitúate en la unidad de la que quieres ver su listado de archivos.

Ejemplo: Visualizar el contenido de un disco

Escribe DIR

Pulsa Intro

Aparecerá un listado de archivos y carpetas, que contienen archivos en su interior, tamaño expresado en bytes, fecha, hora de última actualización (o edición), de la unidad a la que le hemos hecho el DIR.

Si el listado es muy largo (hay muchos archivos), veremos como la pantalla va muy rápida y no nos da tiempo a leerlo todo. Para remediar esto escribe el DIR seguido de /P.

Limpiar la pantalla

Ejemplo: Limpiar la pantalla de caracteres

Escribe CLS

Pulsa Intro

Ahora solo queda el identificador del DOS, a la parte superior izquierda de la pantalla.

Cambiar de directorio

Para cambiar de un directorio a otro emplead la función CD.

Ejemplo: Cambio de directorio

Escribe CD APUNTES

Pulsa INTRO

Ahora veréis a la pantalla C:\APUNTES>, esto significa que estamos dentro del directorio y, por lo tanto, ya podemos trabajar.