Usando Java Comments

Los comentarios de Java son notas en un archivo de código Java que son ignorados por el compilador y el motor de tiempo de ejecución. Se utilizan para anotar el código con el fin de aclarar su diseño y propósito. Puede agregar un número ilimitado de comentarios a un archivo Java, pero hay algunas & amp; quot; best practics & amp; quot; seguir cuando se usan comentarios.

En general, los comentarios de código son & amp; quot; implementation & amp; quot; comentarios que explican el código fuente, como descripciones de clases, interfaces, métodos y campos. Por lo general, se trata de un par de líneas escritas arriba o al lado del código Java para aclarar lo que hace.

Video destacado

Otro tipo de comentario de Java es un comentario de Javadoc. Los comentarios de Javadoc difieren ligeramente en sintaxis de los comentarios de implementación y son utilizados por el programa javadoc.exe para generar documentación HTML de Java.

¿Por qué usar los comentarios de Java??

Es una buena práctica para acostumbrarse a poner comentarios de Java en su código fuente para mejorar su legibilidad y claridad para usted y otros programadores. No es & amp; apos; t siempre borra instantáneamente lo que está realizando una sección & amp; amp; nbsp; del código Java. Algunas líneas explicativas pueden reducir drásticamente la cantidad de tiempo que lleva comprender el código.

¿Afectan cómo se ejecuta el programa??

Los comentarios de implementación en el código Java solo están ahí para que los humanos los lean. Los compiladores de Java no se preocupan por ellos y al compilar el programa, simplemente los omiten. El tamaño y la eficiencia de su programa compilado no se verán afectados por la cantidad de comentarios en su código fuente.

Comentarios de implementación

Los comentarios de implementación vienen en dos formatos diferentes:

• Comentarios de línea: Para un comentario de una línea, escriba & amp; quot; // & amp; quot; y siga las dos barras diagonales con su comentario. Por ejemplo: & lt; pre & gt; // este es un comentario de una sola línea & lt; br & gt ;
  int supposeNumber = (int) (Math.random () * 10); & lt; / br & gt; & lt; / pre & gt; Cuando el compilador se encuentra con los dos cortes hacia adelante, sabe que todo a la derecha de ellos debe considerarse como un comentario. Esto es útil al depurar un código. Simplemente agregue un comentario de una línea de código que está depurando, y el compilador ganó & amp; apos; t lo veo :
  • & lt; pre & gt; // este es un comentario de una sola línea & lt; br & gt ;
    // int guessNumber = (int) (Math.random () * 10); & lt; / br & gt; & lt; / pre & gt; También puede usar las dos barras diagonales para hacer un comentario al final de la línea:
  • & lt; pre & gt; // este es un comentario de una sola línea & lt; br & gt ;
    int guessNumber = (int) (Math.random () * 10); // Un comentario al final de la línea & lt; / br & gt; & lt; / pre & gt ;
• Block Comentarios: Para iniciar un comentario en bloque, escriba & amp; quot; / * & amp; quot ;. Todo entre la barra diagonal y el asterisco, incluso si se trata de una línea diferente, se trata como un comentario de & amp; amp; nbsp; hasta que los caracteres & amp; quot; * / & amp; quot; terminar el comentario. Por ejemplo: & lt; pre & gt; / * esto & lt; br & gt ;
  es & lt; br & gt ;
  a & lt; br & gt ;
  block & lt; br & gt ;
  comentario & lt; br & gt ;
  * / & lt; br & gt ;
  & lt; br & gt ;
  / * también lo es * / & lt; / br & gt; & lt; / br & gt; & lt; / br & gt; & lt; / br & gt; & lt; & lt; / br & gt; & lt; / br & gt; & lt; / pre & gt;

Comentarios de Javadoc

Use comentarios especiales de Javadoc para documentar su API de Java. Javadoc es una herramienta incluida con el JDK que genera documentación HTML a partir de comentarios en el código fuente.

Un comentario de Javadoc en & amp; amp; nbsp;

& lt; pre & gt; .java & lt; / pre & gt; & amp; nbsp; los archivos fuente se incluyen en la sintaxis inicial y final de la misma manera: & amp; amp; nbsp; & lt; pre & gt; / ** & lt; / pre & gt; & amp; nbsp; & amp; & lt; & gt; * & gt;. Cada comentario dentro de estos tiene el precedido de a & amp; amp; nbsp; & lt; pre & gt; *
& lt; p / & gt ;

Coloque estos comentarios directamente encima del método, clase, constructor o cualquier otro elemento Java que desee documentar. Por ejemplo:

& lt; pre & gt; // myClass.java & lt; br & gt ;
/ ** & lt; br & gt ;
* Haga de esta una oración de resumen que describa su clase.& lt; br & gt ;
* Aquí y amp; apos; s otra línea.& lt; br & gt ;
* / & lt; br & gt ;
clase pública & amp; # x200B; myClass & lt; br & gt ;
{& lt; br & gt ;
& lt; br & gt ;…} & lt; / br & gt; & lt; / br & gt; & lt; / br & gt; & lt; / br & gt; & lt; / br & gt; & lt; / br & gt; & lt; / br & gt; & lt; & lt; / pre & gt;

Javadoc incorpora varias etiquetas que controlan cómo se genera la documentación. Por ejemplo, el & amp; amp; nbsp;

& lt; pre & gt; @ param
& lt; p / & gt ;
& lt; pre & gt; / ** método principal & lt; br & gt ;
* @param args String [] & lt; br & gt ;
* / & amp; # x200B; & lt; br & gt ;
público estático vacío principal (String [] args) & lt; br & gt ;
& amp; # x200B; {& lt; br & gt ;
& amp; # x200B; System.out.println (& amp; quot; Hello World!& amp; quot;); & amp; # x200B; & lt; br & gt ;
} & lt; / br & gt; & lt; / br & gt; & lt; / br & gt; & lt; / br & gt; & lt; / br & gt; & lt; & lt; / pre & gt;

Muchas otras etiquetas están disponibles en Javadoc, y también admite etiquetas HTML para ayudar a controlar la salida. Consulte su documentación de Java para obtener más detalles.

Consejos para usar comentarios

• Don & amp; apos; t sobre comentario. No es necesario explicar cada línea de su programa. Si su programa fluye lógicamente y no ocurre nada inesperado, no sienta la necesidad de agregar un comentario.
• Indique sus comentarios. Si la línea de código que está comentando está sangrada, asegúrese de que su comentario coincida con la sangría.
• Mantenga los comentarios relevantes. Algunos programadores son excelentes para modificar el código, pero por alguna razón se olvidan de actualizar los comentarios. Si un comentario ya no se aplica, modifíquelo o elimínelo.
• Don & amp; apos; t comentarios de bloque de nido. Lo siguiente dará como resultado un error del compilador: & lt; pre & gt; / * esto & lt; br & gt ;
  is & lt; br & gt ;
  / * Este comentario en bloque termina el primer comentario * / & lt; br & gt ;
  a & lt; br & gt ;
  block & lt; br & gt ;
  comentario & lt; br & gt ;
  * / & lt; / br & gt; & lt; / br & gt; & lt; / br & gt; & lt; / br & gt; & lt; / br & gt; & gt; & lt; / pre & gt;

& lt; / pre & gt ;
& lt; / pre & gt ;
& amp; # x203A; Informática