Comentarios Java

Comentarios de Java

En este tutorial, aprenderá sobre los comentarios de Java, por qué los usamos y cómo usarlos de manera correcta.

En la programación informática, los comentarios son una parte del programa que los compiladores de Java ignoran por completo. Se utilizan principalmente para ayudar a los programadores a comprender el código. Por ejemplo,

// declare and initialize two variables
int a =1;
int b = 3;

// print the output
System.out.println("This is output");

Aquí, hemos utilizado los siguientes comentarios,

• declarar e inicializar dos variables
• imprimir la salida

Tipos de comentarios en Java

En Java, hay dos tipos de comentarios:

• comentario de una sola línea
• comentario de varias líneas

Comentario de una sola línea

Un comentario de una sola línea comienza y termina en la misma línea. Para escribir un comentario de una sola línea, podemos usar el // símbolo. Por ejemplo,

// "Hello, World!" program example
 
class Main {
    public static void main(String[] args) {    	
    {
        // prints "Hello, World!"
        System.out.println("Hello, World!");
    }
}

Salida :

Hello, World!

Aquí, hemos utilizado dos comentarios de una sola línea:

• "¡Hola, mundo!" ejemplo de programa
• imprime "¡Hola mundo!"

El compilador de Java ignora todo desde // hasta el final de la línea. Por lo tanto, también se conoce como Fin de línea. comentario.

Comentario de varias líneas

Cuando queremos escribir comentarios en varias líneas, podemos usar el comentario de varias líneas. Para escribir comentarios de varias líneas, podemos usar el símbolo /*....*/. Por ejemplo,

/* This is an example of  multi-line comment.
 * The program prints "Hello, World!" to the standard output.
 */

class HelloWorld {
    public static void main(String[] args) {    	
    {	
        System.out.println("Hello, World!");
    }
}

Salida :

Hello, World!

Aquí, hemos utilizado el comentario de varias líneas:

/* This is an example of multi-line comment.
* The program prints "Hello, World!" to the standard output.
*/

Este tipo de comentario también se conoce como Comentario tradicional. . En este tipo de comentario, el compilador de Java ignora todo desde /* a */ .

Use los comentarios de la manera correcta

Una cosa que siempre debe considerar es que los comentarios no deben ser el sustituto de una forma de explicar el código mal escrito en inglés. Siempre debe escribir un código bien estructurado y autoexplicativo. Y luego usa los comentarios.

Algunos creen que el código debería ser autodescriptivo y que los comentarios rara vez deberían usarse. Sin embargo, en mi opinión personal, no hay nada de malo en usar comentarios. Podemos usar comentarios para explicar algoritmos complejos, expresiones regulares o escenarios en los que tenemos que elegir una técnica entre diferentes técnicas para resolver problemas.

Nota :En la mayoría de los casos, utilice siempre comentarios para explicar 'por qué ' en lugar de 'cómo ' y estás listo para irte.