Tipos de comentarios en java

Fibonacci en java

Esta página no se mantiene activamente. Es posible que los enlaces de la documentación no funcionen y que la propia información ya no sea válida. La última revisión de este documento se realizó el 20 de abril de 1999

5.1.3 Comentarios finales Los comentarios muy cortos pueden aparecer en la misma línea que el código que describen, pero deben desplazarse lo suficiente para separarlos de las sentencias. Si aparece más de un comentario corto en un trozo de código, todos deben estar sangrados con la misma configuración de tabulación. Este es un ejemplo de comentario al final del código Java: Copyif (a == 2) {

Objeto en java

}Puedes ver en el ejemplo anterior que he utilizado comentarios de una sola línea para comentar las líneas específicas de un programa. Así es como funciona. Ahora, vamos a entender qué son los comentarios multilínea.2. Comentarios multilíneaPara describir un método completo en un código o un fragmento complejo los comentarios de una sola línea pueden ser tediosos de escribir ya que tenemos que dar ‘//’ en cada línea. Así que para superar esto se pueden utilizar comentarios multilínea. Los comentarios multilínea comienzan con /* y terminan con */. Cualquier texto entre /* y */ será ignorado por Java. Se utiliza para comentar múltiples líneas de código.Ahora, vamos a tomar un pequeño ejemplo para saber cómo los comentarios multilínea pueden ser utilizados.public class Example2 {

Operador en java

En Java Software, tenemos varias directrices que pueden hacer que nuestros comentarios de documentación sean diferentes a los de terceros desarrolladores. Nuestros comentarios de documentación definen la especificación oficial de la API de la plataforma Java. Para ello, nuestro público objetivo son quienes escriben pruebas de compatibilidad con Java, o conforman o reimplementan la plataforma Java, además de los desarrolladores. Dedicamos tiempo y esfuerzo a especificar las condiciones de contorno, los rangos de argumentos y los casos de esquina en lugar de definir los términos comunes de programación, escribir resúmenes conceptuales e incluir ejemplos para los desarrolladores.

Por lo tanto, hay comúnmente dos maneras diferentes de escribir los comentarios de los documentos – como especificaciones de la API, o como documentación de la guía de programación. Estos dos objetivos se describen en las siguientes secciones. Un personal con recursos generosos puede permitirse mezclar ambos en la misma documentación (debidamente “fragmentada”); sin embargo, nuestras prioridades dictan que nos centremos principalmente en escribir las especificaciones de la API en los comentarios de la documentación. Por ello, los desarrolladores a menudo tienen que recurrir a otros documentos, como la Documentación Técnica de Java SE y los Tutoriales de Java para obtener guías de programación.

Comentarios de la documentación de Java

El lenguaje Java proporciona tres estilos (Single Line, Multi-line y Javadoc) de comentarios. Antes de hablar de un tipo de comentario Java en particular debemos saber que un comentario Java puede ser insertado en cualquier parte del código de un programa donde pueda haber un espacio en blanco. El compilador de Java no los incluye en el ejecutable final. Por lo tanto, se pueden insertar tantos comentarios Java como se quiera hasta que se demuestre su utilidad. Java admite los siguientes tres estilos de comentarios.

Los comentarios de una y varias líneas de Java se denominan colectivamente comentarios de implementación, mientras que los comentarios Javadoc se denominan comentarios de documentación. Los comentarios de implementación se utilizan para la documentación interna. Para documentar internamente un programa se insertan comentarios de implementación no ejecutables y legibles por humanos. Estos comentarios deben utilizarse para dar una visión general del código y proporcionar información adicional que no está disponible en el propio código.

El comentario de una sola línea de Java comienza con dos barras inclinadas sin espacios en blanco (//) y dura hasta el final de la línea. Si el comentario sobrepasa una línea, entonces coloca dos barras consecutivas más en la línea siguiente y continúa el comentario.