Vuelves a tu programa un mes después
Abres un programa que escribiste en septiembre. No entiendes nada. ¿Qué es d? ¿Por qué se multiplica por 0,9?
Si a ti te pasa con tu propio código, imagina a un compañero.
La solución es explicar el programa mientras lo escribes.
Palabras clave
| Palabra | Qué significa | Ejemplo |
|---|---|---|
| Comentario | Un texto dentro del código que Java ignora. Es solo para personas. | // Descuento del club |
| Comentario de línea | Un comentario que empieza con dos barras y llega hasta el final de la línea. | // una línea |
| Comentario de bloque | Un comentario que ocupa varias líneas, entre barra-asterisco y asterisco-barra. | /* varias líneas */ |
| Nombre claro | El nombre de una variable que dice qué guarda. | ticketPrice, no p |
| Documentación | Los textos que explican qué hace un programa y cómo se usa. | Comentarios y README |
| README | Un archivo de texto que cuenta qué es el proyecto. Es lo primero que se lee. | README.md |
Las celdas que rellenan los estudiantes quedan en blanco en esta vista previa.
Un comentario es una nota para personas
Java ignora los comentarios. El programa funciona igual con ellos o sin ellos.
Hay dos formas. Con // el comentario llega al final de la línea. Con /* y */ puede ocupar varias líneas.
Ejecuta el programa de abajo y comprueba que los comentarios no salen en la consola.
Pruébalo: Java ignora los comentarios
public class Main {
public static void main(String[] args) {
// Este comentario ocupa una línea. Java lo ignora.
int tickets = 4;
double price = 12.5;
/* Un comentario de bloque
puede ocupar varias líneas. */
double total = tickets * price;
// El 10 % de descuento lo pide el club de fans.
double toPay = total * 0.9;
System.out.println("Pagas " + toPay + " euros");
}
}
Cuenta el porqué, no el qué
El código ya dice qué hace. Mira total = tickets * price. No hace falta repetirlo.
Lo que el código no dice es por qué. ¿Por qué un 10 % de descuento? ¿Por qué 50 como límite?
Ese porqué es lo que merece un comentario.
Comentarios inútiles y útiles
| Línea de código | Comentario inútil | Comentario útil |
|---|---|---|
| total = tickets * price; | // multiplica las entradas por el precio | // Total antes del descuento del club |
| toPay = total * 0.9; | // multiplica por 0.9 | // El club de fans paga el 90 % del precio |
| int maxGroup = 50; | // el máximo es 50 | // Plazas del autobús: no caben más de 50 |
| age = age + 1; | // suma uno a age | // Cumple años: lo guardamos en la ficha |
Las celdas que rellenan los estudiantes quedan en blanco en esta vista previa.
¿Útil o inútil?
Inténtalo
¿Útil o inútil?
4 preguntasTus respuestas se corrigen aquí y no se guardan. Una cuenta guarda tus resultados.
Un buen nombre vale más que un comentario
Compara d = c * 0.9 con toPay = total * 0.9. El segundo casi no necesita comentario.
Elige nombres que digan qué guarda la variable. Mejor largo y claro que corto y misterioso.
Prueba los dos programas. Hacen lo mismo, pero solo uno se entiende.
Pruébalo: nombres misteriosos
public class Main {
public static void main(String[] args) {
int a = 4;
double b = 12.5;
double c = a * b;
double d = c * 0.9;
System.out.println(d);
// Funciona, pero ¿qué es cada letra?
// Cámbialas por nombres claros: tickets, price, total, toPay.
}
}