Comentarios en Java

Los comentarios en Java , como en la mayoría de los demás lenguajes de programación, son caracteres que se ignoran durante la ejecución del programa. Así, podrás añadir tantos comentarios al programa como necesites sin miedo a aumentar su tamaño. Los comentarios se utilizan para describir las complejidades de un bloque de código, método o clase en particular. También puedes utilizarlos si quieres dejar mensajes a los programadores que trabajarán con este código en el futuro. O para tus propias notas.

Formas de resaltar comentarios

Java tiene dos formas de resaltar comentarios en el texto.

Comentario de implementación (comentario de código)

1. Comentando una línea

   Este es el tipo de comentario más utilizado. Para escribir un comentario de este tipo, debe utilizar dos barras diagonales //. En este caso, el comentario comienza inmediatamente después de los caracteres //y continúa hasta el final de la línea.

   System.out.println("Hello, Java world!");
   // наш комментарий

2. Comentar un bloque de texto

   Si necesita comentarios más largos, puede comenzar cada línea con símbolos. Aunque es más conveniente limitar los bloques de comentarios a delimitadores /*y */.

   /*
    Пример простой программы на Java
   */
   
   public class SampleProgram
   {
    public static void main (String [] args)
    {
    System.out.println("Hello, Java world!");
    }
   }

   No debemos olvidar que los comentarios, separados por símbolos, /*no */se pueden anidar en el lenguaje Java. Esto significa que un fragmento de código no se puede deshabilitar simplemente rodeándolo con /*y , ya que el código que se deshabilita puede contener */delimitadores /*y */.

Comentario documentario

Para documentar métodos, variables o clases, se utiliza un método especial para resaltar texto. Esto se hace usando /**y */. En este caso, cada línea de texto comentado comienza con *Si se documenta un método, se acostumbra describir sus argumentos y su valor de retorno.

/**
* Метод возвращает максимальное significado
* из трех переданных аргументов
* @param a - первый параметр
* @param b - второй параметр
* @param c - третий параметр
* @return - максимальный из параметров
*/
public int max(int a, int b, int c) {
   return Math.max(Math.max(a, b), c);
}

¿Qué más leer? Por ejemplo, este material: Comentarios en Java: no todo es tan sencillo . O una conferencia de la búsqueda Java Syntax Pro sobre comentarios.