Comentarios

Como crear comentarios en Java

Los comentarios se usan en java por un par de razones diferentes. Pueden explicar el código Java, haciéndolo más legible y fácil de entender para los demás. También se puede usar para evitar la ejecución al probar diferentes secciones de código en un programa. Estas funciones se vuelven cada vez más importantes a medida que comenzamos a trabajar con programas más grandes que consisten de múltiples archivos que trabajan juntos.

Las diferentes formas de crear comentarios en python:

En java existen tres tipos de comentarios. De estos dos son comentaros regulares (una y varias lineas) que tambien se encuentran en otros lenguajes de programacion. El ultimo se usa para crear comentarios en javadoc. Javadoc es un generador de documentacion que genera documentacion API en formato HTML a partir del codigo fuente de Java.

  • Comentarios de una linea

Para crear comentarios de una linea usamos dos lineas diagonalesn //. En este caso el compilador ignora todo despues de //.

				
					// sintaxis:
// comentario

// Programa usando comentarios de una linea
//////////////////////////////////////////////////
// Ejemplo 1: ejemplo de programación donde los números se suman

import java.io.*;

class Suma {
	public static void main(String[] args)
	{
		// inicializando variables
		int numero1 = 80, numero2 = 20, sum = 0;

		// monstrando numero1 y numero2
		System.out.println("numero 1 = " + numero1);// salida : 80
		System.out.println("numero 2 = " + numero2);// salida : 20

		// sumando numero1 y numbero2
		suma = numero1 + numero2;
		System.out.println("La suma = " + suma);// salida : 100
	}
}

				
			
  • Comentarios de varias lineas

Los comentarios de varias líneas se incluyen entre los símbolos /* y */. En este caso el compilador ignora todo, desde /* hasta */.

				
					// sintaxis:
/* comentarios
*/

// Programa usando comentarios multi-linea
//////////////////////////////////////////////////
/* El siguiente código imprimirá las palabras Hello World
a la pantalla*/
System.out.println("Hola Mundo");
				
			
  • Comentarios Usando Javadoc

/** documentación */
Este es un comentario de documentación y, en general, se llama comentario de documento. La herramienta javadoc de JDK utiliza comentarios de documentos al preparar la documentación generada automáticamente.

				
					import java.io.*;
/**
* <h1>Numero entero más pequeño</h1>
* Este programa encuentra el numero entero más pequeño en una matriz.
* <p>
* <b>Nota:</b> Comentarios en un programa agregan a la credibilidad de un programa.
*
* @author  Jose 
* @version 1.0
* @since   2022-03-31
*/
public class NumeroPequeno {
   /**
   * Este método atraviesa una matriz dada y devuelve el numero entero más pequeño encontrado.
   * @param numA Este es el primer parametro de el metodo pequeno
   * @param numB Este es el segundo parametro de el metodo pequeno
   * @return int esto regresa el numero mas pequeno del array
   */
  public int pequeno(int arr []) {
        int a = arr[0];
        int index=0;
        while(index<arr.length) {
            //verificar si el más pequeño es mayor que el elemento
            if(a>arr[index]) {
                //actualización 
                a=arr[index];
            }
            index++;
        }
      return a;
   }
   /**
   * Este es el metodo central que usa el metodo pequeno
   * @param args no se usa
   * @return no regresamos nada
   * @exception IOException solo se lanza en caso de un error de entrada
   */
   public static void main(String args[]) throws IOException {
      NumeroPequeno obj = new NumeroPequeno();
      int[] lista = {13,4,66,4,22,42,9};
      int p = obj.pequeno(lista);

      System.out.println("El numero mas pequeno es :" + p);
   }
}
				
			

¿Por qué son importantes los comentarios?

Al trabajar en un proyecto más grande, se espera que todos contribuyan a diferentes partes del proyecto. Por lo tanto, es importante que sus socios no solo puedan descubrir en qué partes ha trabajado, sino también cómo pueden conectar su código al suyo de la manera más eficiente posible. En muchos casos, es fácil saber qué hace un programa con un vistazo rápido a las definiciones de variables y funciones.

Pero una vez que los programas tienen miles de líneas, es más fácil para ellos hacer referencia a un método que ha escrito al tener comentarios en línea. Los comentarios en línea deben usarse con moderación para aclarar fragmentos de código que no son evidentes por sí solos. Esto los ayudaría enormemente a prevenir futuros dolores de cabeza.