Introducción
Comentarios de una linea
Los comentarios de una línea se utilizan para agregar explicaciones o notas en una sola línea de código. Java considera todo después de las dos barras inclinadas (//) como un comentario hasta el final de la línea.
public class HolaMundo {
public static void main(String[] args) {
// Este es un comentario de una línea
System.out.println("¡Hola, Mundo!");
}
}
Comentarios de varias lineas
Los comentarios de varias líneas se utilizan para escribir comentarios que abarcan varias líneas. Se encierran entre /* y */.
/*
Nombre: Jose Alvarez
Clase: COMP 301
Fecha: 04/1/2012
Resumen: Este programa verifica si un numero es primo.
*/
public class VerificadorNumerosPrimos {
/**
* Verifica si un número dado es primo.
*
* @param numero El número que se verificará.
* @return Verdadero si el número es primo, falso en caso contrario.
*/
public static boolean esPrimo(int numero) {
if (numero <= 1) {
return false; // Los números menores o iguales a 1 no son primos
}
if (numero <= 3) {
return true; // 2 y 3 son números primos
}
if (numero % 2 == 0 || numero % 3 == 0) {
return false; // Divisible por 2 o 3, no es primo
}
// Verifica la divisibilidad con números en la forma 6k +/- 1
for (int i = 5; i * i <= numero; i += 6) {
Comentarios Javadoc
Los comentarios Javadoc se utilizan con fines de documentación. Proporcionan información sobre clases, métodos y campos, y se utilizan para generar automáticamente documentación de API utilizando herramientas como javadoc.
/**
* Esta clase muestra el uso de todas las etiquetas de Javadoc.
* Implementa una utilidad simple para operaciones aritméticas básicas.
*/
public class EjemploEtiquetasJavadoc {
/**
* Suma dos enteros y devuelve el resultado.
*
* @param a El primer operando entero.
* @param b El segundo operando entero.
* @return La suma de los dos enteros.
*/
public int sumar(int a, int b) {
return a + b;
}
/**
* Resta un entero de otro y devuelve el resultado.
*
* @param minuendo El entero del que se restará el sustraendo.
* @param sustraendo El entero que se restará del minuendo.
* @return La diferencia entre el minuendo y el sustraendo.
*/
public int restar(int minuendo, int sustraendo) {
return minuendo - sustraendo;
}
/**
* Multiplica dos enteros y devuelve el resultado.
*
* @param factor1 El primer factor entero.
* @param factor2 El segundo factor entero.
* @return El producto de los dos enteros.
*/
public int multiplicar(int factor1, int factor2) {
return factor1 * factor2;
}
/**
* Divide un entero entre otro y devuelve el resultado.
*
* @param dividendo El entero que será dividido.
* @param divisor El entero por el cual se dividirá el dividendo.
* @return El resultado de la división.
* @throws ArithmeticException Si el divisor es cero.
*/
public double dividir(int dividendo, int divisor) throws ArithmeticException {
if (divisor == 0) {
throw new ArithmeticException("No está permitida la división por cero.");
}
return (double) dividendo / divisor;
}
/**
* Método principal para demostrar el uso de las operaciones aritméticas.
*
* @param args Los argumentos de la línea de comandos (no utilizados en este ejemplo).
*/
public static void main(String[] args) {
EjemploEtiquetasJavadoc ejemplo = new EjemploEtiquetasJavadoc();
int num1 = 10;
int num2 = 5;
System.out.println("Suma: " + ejemplo.sumar(num1, num2));
System.out.println("Diferencia: " + ejemplo.restar(num1, num2));
System.out.println("Producto: " + ejemplo.multiplicar(num1, num2));
try {
System.out.println("Cociente: " + ejemplo.dividir(num1, num2));
} catch (ArithmeticException e) {
System.out.println("Error: " + e.getMessage());
}
}
}
Buenas Practicas Para Comentar
Usa comentarios con moderación y solo cuando sea necesario para evitar saturar el código. Mantén los comentarios concisos y al punto. Asegúrate de que tus comentarios estén actualizados con el código correspondiente. Evita comentarios redundantes que repiten lo obvio. Evita usar comentarios para explicar código mal escrito; esfuérzate por tener un código limpio y autoexplicativo.