Programacin Bsica en Java

By Jorge Gonzlez Tapia

Contenido
Programacin Bsica en Java .............................................................................................................. 1 2.1. Codificacin Java ...................................................................................................................... 1 2.1.1. Archivos .java.................................................................................................................... 1 2.1.2. Comentarios .......................................................................................................................... 1

2.1. Codificacin Java

Un programa en Java consiste de una serie de declaraciones de clases e Interfaces, cada una de las cuales se compone de declaraciones de mtodos y Variables. Estas declaraciones se presentan formando un texto o cdigo que Es almacenado en un archivo fuente. Aun cuando las declaraciones de varias Clases y/o interfaces pueden ser almacenadas en el mismo archivo fuente, tpicamente cada declaracin se almacena en un archivo separado. Esto no se debe solo a preferencia, sino que tambin se relaciona con la forma en que las clases de Java se cargan cuando un programa se ejecuta.

2.1.1. Archivos .java Los archivos fuente siempre tienen nombres con la terminacin .java. La primera parte del nombre del archivo es el nombre de la clase o interfaz declarada en el propio archivo. Por ejemplo, una clase Test se almacenara en un archivo Test.java. Si un archivo contiene la declaracin de ms de una clase o interfaz, el archivo debe ser nombrado a partir de una de ellas, la cual debe ser la nica clase o interfaz pblica (public) en el archivo.

2.1.2. Comentarios
Los comentarios en Java tienen tres formas: // Este es un comentario de una sola lnea /* Este es un comentario multilinea */ /** Este es un comentario para documentacin */ Los comentarios para documentacin se reconocen mediante la herramienta

javadoc, la cual lee los comentarios de documentacin y automticamente genera pginas HTML conteniendo una versin limpiamente formateada de la informacin de los comentarios. Cada pgina documenta una clase y lista cada variable miembro junto con cualquier informacin o comentario provisto. Las bibliotecas de Java se documentan usando los comentarios para documentacin y la herramienta javadoc. Los comentarios para documentacin empiezan con una marca /** y Terminan con */. Pueden extenderse por mltiples lneas, pero no pueden ser anidados. Solo los comentarios para declaracin inmediatamente antes de la declaracin de clases, interfaces, variables miembro y mtodos se reconocen por javadoc como comentarios para documentacin. En cualquier otro lado, un comentario para documentacin se considera solo como un comentario multilnea. Dentro de un comentario para documentacin pueden aparecer varias etiquetas que permiten procesar la informacin del comentario en formas especificas por la herramienta javadoc. Cada etiqueta se marca por un smbolo @, y debe comenzar en una lnea aparte. Las siguientes etiquetas se encuentran disponibles: @author. Nombre del o los autores del cdigo que se comenta. El nombre del autor se escribe simplemente como texto: @author Daniel Lpez Pueden utilizarse varias etiquetas con diferentes autores, o varios nombres pueden ser considerados en la misma etiqueta: @author Daniel Lopez, Javier Jimenez @deprecated. Se usa para indicar que la siguiente clase o mtodo se ha cambiado de una versin anterior del cdigo, y ser removido en versiones futuras. La etiqueta puede ser seguida de una corta explicacin: @deprecated No ser disponible en siguientes versiones Idealmente, @deprecated debe seguirse de una etiqueta @see que dirijaal lector al punto de reemplazo. Esta etiqueta es adicionalmente reconocida por el compilador de Java, lo que genera un mensaje de advertencia (warning) si el cdigo se utiliza. @exception. Provee de informacin sobre las excepciones que puedenarrojarse a partir de un mtodo. Un nombre de excepcin puede aparecer Despus de la etiqueta seguida de un comentario de texto. @exception IndexOutOfBoundsException Intento de accesar un elemento invalido Un comentario para documentacin puede contener varias etiquetas @exception. @param. Provee informacin sobre parmetros de mtodos y constructores.

La etiqueta es seguida del nombre del parametro y de un comentario: @param size Tamano de una estructura de datos Estas etiquetas solo deben aparecer en comentarios precediendo metodos y constructores. Idealmente, debe haber una etiqueta por cada parametro, presentandose en el mismo orden de los parametros. @return. Documenta el valor de retorno de un metodo. @return El indice de un elemento identificado El comentario es texto simple. Un comentario para documentacion debe solo contener una etiqueta @return, ya que solo puede haber un solo valor de retorno. @see. Provee una referencia cruzada a otra clase, interfaz, metodo, variable o URL. Las siguientes son referencias validas: 13 @see java.lang.Integer @see Integer @see Integer#intValue @see Integer#getInteger(String) @see <a href="info.html">Vease aqui para mayor informacion</a> Las clases e interfaces pueden ser referenciadas tanto por su nombre como por el nombre completo del paquete al que pertenecen. Las variables y metodos miembro pueden referenciarse mediante anadir su nombre al nombre de la clase siguiendo el smbolo #. Los URLs pueden aparecer si se hace un formato utilizando las etiquetas <a>...</a> de HTML. Multiples etiquetas @see pueden aparecer en el mismo comentario. @since. Se usa para establecer cuando una caracterstica particular fue incluida (por ejemplo, desde cundo se ha hecho disponible). La etiqueta se sigue por un texto dando la informacin requerida: @since JDK1.0 @version. Se utiliza para dar informacin sobre la versin de la revisin actual del cdigo siendo comentado. El formato para la informacin sobre la versin no est especificado, y se deja al programador. Una convencin no oficial que se est utilizando cada vez ms es aquella en que el nmero de la versin se sigue por la fecha de liberacin (release date): @version 1.2 20.8.1997 Solo una etiqueta de versin puede aparecer dentro de un comentario. El texto incluido en un comentario para documentacin puede tambin marcarse con etiquetas HTML usadas para controlar la apariencia del texto, incluyendo <code>...</code> (que delimita el texto utilizando la letra para cdigo de programacin), y <p> (que indica el comienzo de un nuevo prrafo, y que se utiliza frecuentemente tambin como delimitador de la forma <p>...</p>). Consltese libros sobre HTML para detalles referentes a la notacin de ese lenguaje. La siguiente declaracin de una clase ilustra el uso de los comentarios para documentacin:

/** Esta es una clase de prueba para mostrar el uso de comentarios para

documentacion. @author Daniel Lopez @see java.lang.String @version 1.0 10.8.1997 */ public class Comment1 { /** Retorna el argumento multiplicado por 2. @param x El valor entero a ser duplicado. @return El argumento del metodo multiplicado por 2. @deprecated Sera removido en la siguiente version de la clase. @see #multiplyByTwo */ public int times2 (int x) { return x*2; } /** Retorna el argumento multiplicado por 2, reemplazando la version anterior de este metodo. @param x El valor entero a ser duplicado. @return El argumento del metodo multiplicado por 2. */ public int multiplyByTwo (int x) { return 2*x; } /** La funcion main usada para probar la clase. @param args argumentos de linea de comando (no usados) */ public static void main(String[] args) { Comment1 test = new Comment1(); int n = test.times2(5); n = test.multiplyByTwo(10); System.out.println(s); } /** Una cadena de caracteres utilizada por la funcion <code>main</code>. */ static String s = "Hello"; }