Saltar al contenido
Home » Comentarios

Comentarios

Introducción

Los comentarios en java son esenciales para mejorar la legibilidad del codigo y explicar el proposito de varios segmentos de codigo. Son declaraciones no ejecutables que proporcionan informacion sobre el codigo a los desarrolladores y otros lectores. 

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&#xFA;meros menores o iguales a 1 no son primos
        }
        if (numero <= 3) {
            return true; // 2 y 3 son n&#xFA;meros primos
        }
        if (numero % 2 == 0 || numero % 3 == 0) {
            return false; // Divisible por 2 o 3, no es primo
        }
        // Verifica la divisibilidad con n&#xFA;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&#xE9;ticas b&#xE1;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&#xE1; el sustraendo.
     * @param sustraendo El entero que se restar&#xE1; 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&#xE1; dividido.
     * @param divisor El entero por el cual se dividir&#xE1; el dividendo.
     * @return El resultado de la divisi&#xF3;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&#xE1; permitida la divisi&#xF3;n por cero.");
        }
        return (double) dividendo / divisor;
    }
    /**
     * M&#xE9;todo principal para demostrar el uso de las operaciones aritm&#xE9;ticas.
     *
     * @param args Los argumentos de la l&#xED;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.