Comentarios

Es muy conveniente comentar el código de nuestros programas para aclarar cosas que seguramente pasado un tiempo no sabremos muy bien qué hacían. Así mismo, si otra persona lee nuestro código, se lo pondremos más fácil si le vamos dando pistas de su funcionamiento.

En Java se utilizan dos formas para comentar el código, heredadas de los lenguajes C y C++:

package cap01;

public class HolaMundo {

    public static void main(String[] args) {
       
        // Esto es un comentario de una sola línea
       
        System.out.println("Hola mundo");
       
        /* Los comentarios de varias líneas
         * se escriben de este modo.
         */

    }

}

Hay una tercera manera de comentar código en Java, los comentarios javadoc, pero esta funcionalidad la veremos más adelante.

Suele dar pereza escribir comentarios mientras se programa, pero creedme que es muy conveniente hacerlo. No vamos a comentar trivialidades, pero sí merece la pena comentar aspectos del código más dificiles de entender o, de lo contrario, nos costará volver a coger el hilo del programa cuando lo retomemos, nosotros u otra persona.

Comentarios

Publicar un comentario

Entradas populares de este blog

Mostrar texto en pantalla: print(), println() y printf()

En una entrada anterior vimos cómo mostrar un texto en pantalla con el método println() . Es fácil entender que lo que se escribe entre paréntesis es lo que se muestra luego en pantalla, pero ¿qué diantres es System.out ? De manera muy somera, diremos que System.out es el objeto de salida estándar en Java. Más adelante veremos más detalles sobre ello. Sin embargo, nos interesa ahora saber que este objeto tiene métodos para realizar determinadas acciones. Precisamente uno de los métodos es el ya visto println() que muestra el texto que escribimos entre paréntesis y posiciona el cursor en una nueva línea. Otro método es print() , similar al anterior, pero que deja el cursor en la misma línea después de mostrar el texto. El siguiente ejemplo muestra las diferencias entre los dos métodos: package cap01; public class HolaMundo {     public static void main(String[] args) {                System.out.println("Hola mu...
Leer más

Introducción a la entrada: la clase Scanner

¿Os parece complicada la forma que tiene Java de imprimir un texto en pantalla? Pues si el procedimiento de salida es complicado, no es nada comparado con el de entrada de datos al programa por parte del usuario. Hay que llevar a cabo nada menos que 3 pasos para poder capturar la entrada de datos al programa: - Importar un paquete - Crear un objeto - Capturar la entrada en una variable Mejor lo vemos primero en un ejemplo y luego analizamos cada parte. package cap02; import java.util.Scanner; public class Suma {     public static void main(String[] args) {                 Scanner entrada = new Scanner(System.in);                 System.out.print("Escribe un entero: ");         int num1 = entrada.nextInt();                 System.out.print("Escribe otro...
Leer más

Operaciones relacionales y de igualdad

Estos operadores se usan para evaluar condiciones, es decir, comprobar si una determinada condición es verdadera o falsa. Tienen su aplicación fundamentalmente en estructuras condicionales que veremos más adelante. Los operadores relacionales son: >     mayor que <     menor que >=   mayor o igual que <=   menor o igual que Los de igualdad son: ==   igual a !=    distinto de No confundir el operador de asignación = con el de igualdad ==. Parece una tontería, pero luego se despista uno y los cambia.
Leer más