-Tipos
de comentarios
Existen tres tipos de comentarios. Los comentarios de línea, de bloque y los javadoc.
-Comentarios
de línea
Los comentarios de línea se utilizan para comentar en una sola línea, una sentencia, explicar la definición de una variable, o un paso a paso del código que se esta observando. Un ejemplo de comentario de línea es el siguiente:
int num = 5 // este comentario me permite decir que esta es una asignación de un numero.
Los comentarios de línea se utilizan para comentar en una sola línea, una sentencia, explicar la definición de una variable, o un paso a paso del código que se esta observando. Un ejemplo de comentario de línea es el siguiente:
int num = 5 // este comentario me permite decir que esta es una asignación de un numero.
-Comentarios de bloque
Los comentarios de bloque permiten comentar un bloque de código o simplemente agregar varias líneas de texto para explicar algo que solo debe ser visto en el momento de la programación. El modo de utilizarlo es el siguiente:
/*
En este comentario se puede explicar varias cosas.
Algunas condiciones que se deben cumplir para continuar con la ejecución del código
Algun código alternativo en caso de estar testeando alguna versión, o modificando el programa.
O simplemente dejar alguna advertencia sobre el código que se esta observando
*/
Los comentarios de bloque permiten comentar un bloque de código o simplemente agregar varias líneas de texto para explicar algo que solo debe ser visto en el momento de la programación. El modo de utilizarlo es el siguiente:
/*
En este comentario se puede explicar varias cosas.
Algunas condiciones que se deben cumplir para continuar con la ejecución del código
Algun código alternativo en caso de estar testeando alguna versión, o modificando el programa.
O simplemente dejar alguna advertencia sobre el código que se esta observando
*/
-Comentarios Javadoc
Los comentarios del tipo javadoc permiten documentar de una forma mas útil, mas publica nuestro programa. Pueden ir en cualquier sector de las clases, los packages, los atributos, los métodos. Una vez que esta documentación se ha escrito explicando o definiendo una clase, un paquete o los atributos o métodos, con la ejecución de la herramienta javadoc se obtiene un sitio con la api del programa, donde se encontraran las explicaciones que se fueron agregando en las clases. Todos estos comentarios son vinculados como en la api de java standard.
Los comentarios del tipo javadoc permiten documentar de una forma mas útil, mas publica nuestro programa. Pueden ir en cualquier sector de las clases, los packages, los atributos, los métodos. Una vez que esta documentación se ha escrito explicando o definiendo una clase, un paquete o los atributos o métodos, con la ejecución de la herramienta javadoc se obtiene un sitio con la api del programa, donde se encontraran las explicaciones que se fueron agregando en las clases. Todos estos comentarios son vinculados como en la api de java standard.
-Caracteres
especiales
La representación de caracteres especiales como el salto de línea o la tabulación, se logran a partir de la barra (\). Los caracteres especiales mas utilizados son:
La representación de caracteres especiales como el salto de línea o la tabulación, se logran a partir de la barra (\). Los caracteres especiales mas utilizados son:
ü \n à Nueva línea
ü \t à Tabulador
ü \’ à Comilla simple
ü \” à Comilla doble
ü \\ à Barra
No hay comentarios:
Publicar un comentario