Universidad Politcnica de Tulancingo

Archivos Para los nombres e establecen las siguientes convenciones: 1. Los archivos en java tienen extensin .java. 2. Las clases en java tienen extensin .class. 3. Los nombres de los archivos deben ser claros, sencillos, simples y descriptivos. Por ejemplo: VideoTienda.java Cliente.class Organizacin En la organizacin de los archivos hay que tener en cuenta tres aspectos, estos son: I. Comentarios de inicio. Suministran informacin sobre el nombre de la clase, la versin, la fecha y copyright. Por ejemplo: /* * Clase Cliente * * Versin * * 8 de Marzo de 2010 * * Jos Alberto San Juan San Agustn */ Nota: para cada palabra escrita en los comentarios debe existir un espacio entre las diagonales y el texto o el asterisco y el texto. Identacin Significa mover un bloque de textos a la derecha utilizando espacios en blanco. Se usan con el fin de mejorar la legibilidad del cdigo fuente por parte de los programadores. Se recomienda usar 4 espacios en blanco como unidad de identacion y un espacio para la apertura de llaves. Ejemplo: Public String limpiarCadena(String s) { ----int I; ----for(i=s.length();i>0;i--) Comentarios Existen dos tipos de comentarios: de implementacin y de documentacin. Los primeros se usan para comentar el cdigo o una implementacin especfica a travs de los caracteres /**/ y //. Sin embargo, los de documentacin se usan para describir especificaciones del cdigo usando los caracteres /***/.

Recomendaciones. 1) Claros 2) Apropiados 3) Evitar la redundancia 4) No incluir caracteres especiales Jos Alberto San Juan San Agustin Pgina 1

Universidad Politcnica de Tulancingo

5) No hacer uso excesivo de asteriscos u otros caracteres en su diseo 6) Demasiados comentarios disminuyen la calidad del software Los comentarios de implementacin se clasifican en: a) Cometarios de bloque: son usados en el comienzo de cada archivo, antes de cada mtodo o en el interior de estos, con el fin de dar una descripcin de los mismos. Estn precedidos por una lnea en blanco. Ejemplo: /** * Mtodo que retorna el valor total del alquiler * de pelculas */ b) Comentarios de una lnea. Son comentarios cortos identados al mismo nivel de l lnea de cdigo que sigue. Estn precedidos por una lnea en blanco. Ejemplo: If(alquiler==1) { /**La pelcula se encuentra alquilada*/ } c) Comentarios de aclaracin. Aparecen en la misma lnea del cdigo comentado. Se escribe a una distancia prudente de tal manera que no confundan al cdigo mismo. Cuando se escribe ms de un comentarios esto deben ser identados al mismo nivel. Ejemplo: public int buscarCodigp(double id) { int pos=-1; /**No encontrado*/ for(int i=0;i<10;i++) { if(obtenerCodigo(i)==id) { pos=i; /**Encontrado*/ break; } } return pos; } d) Comentarios de fin de lnea. Convierten una lnea o parte de ella en comentarios usando los caracteres //. Tambin se pueden comentar secciones de cdigo completas. Ejemplo: public int buscarCodigp(double id) { int pos=-1; // for(int i=0;i<10;i++) { if(obtenerCodigo(i)==id) { pos=i; break; // no sera necesario } // } return pos; Jos Alberto San Juan San Agustin Pgina 2

Universidad Politcnica de Tulancingo

} Los comentarios de documentacin describen las clases, interfaces, constructores, mtodos y atributos. Van siempre ubicados antes de la declaracin y con los caracteres /***/. Este tipo de comentarios no se describen dentro del bloque de un mtodo o un constructor, ya que java asocia el comentario con la primer sentencia que se encuentra despus de este. Ejemplo: /** * el mtodo buscarCodigo realiza una bsqueda * secuencial del cdigo del cleinte delntro del * arreglo */ public int buscarCodigp(double id) { } Declaraciones Cantidad En la cantidad de declaraciones por lnea, una sola declaracin por lnea, ya que favorece el uso de comentarios. Ejemplos: int posicion; // un lugar del arreglo int tamanio; // tamao del arreglo Por otro lado, se sugiere no hacer declaraciones de diferentes tipos en la misma lnea. Inicializacin La inicializacin es la asignacin de valores iniciales a las variables. Al declararlas, se hace necesario inicializarlas inmediatamente en el lugar en el que han sido declaradas. Si esta accin no se efecta , debe ser slo por que el valor inicial de dicha variable depende de un clculo u operacin a realizar. Ejemplo: int tamao=300; public int buscarCodigp(double id) { int pos=-1;

Ubicacin La ubicacin de las declaraciones es siempre al inicio de cada bloque (cdigo delimitado por {}), excepto cuando se hace uso de ndices en bucles como for. Jos Alberto San Juan San Agustin Pgina 3

Universidad Politcnica de Tulancingo

Ejemplo: public int buscarCodigp(double id) { int pos=-1: for(int i=0;i<10;i++) { } Clases e interfaces Para la declaracin de clases he interfaces, se deben tener en cuenta los siguientes aspectos: 1. Debe existir al menos una lnea en blanco que separe los mtodos . 2. No dejar espacios en blanco entre el nombre del mtodo y el parntesis de la lista de parmetros. 3. La llave de apertura { debe estar ubicado al final de la lnea de declaracin de sentencia. 4. La llave de } se identa al comienzo de la lnea, de tal manera que se alinee con la sentencia de apertura, excepto cuando se trata de un mtodo vaco. Ejemplo: public class ErchivoEjemplar { private RandomAccessFile archivo; Ejemplar ejemplar; public void sePosicion(long pos){ try { archivo.seek(pos); }catch(Exception err) {} } public long getPosicion() { long p=0; try{ p=archivo.getFilePointer(); } catch(Exception error) {} return p; } }

Sentencia simples En las sentencias simples, se recomienda que cada lnea contenga una sola sentencia.

Ejemplo: Posicin ++; Jos Alberto San Juan San Agustin Pgina 4

Universidad Politcnica de Tulancingo

Alquiler--; compuestas Son los conjuntos de sentencias encerradas entre llaves {}. Ejemplo: public void instanciar() { archivoPelicula=aP; archivoEjemplar=aE; rehEjemplar=rE; } Nota. Tener en cuenta las reglas de identacin segn el nivel de la sentencia, la ubicacin de las llaves. Evitar el olvido de las llaves de cierre. De retorno En el uso de la sentencia return no debe usarse parntesis () , a menos que el valor devuelto sea el resultado de alguna operacin. Ejemplo. public String actor() { return actor; } return s.substring(0,i); return (alquiler+iva);

If, if-else Esta sentencia siempre lleva llaves {} en cualquiera de sus casos. 1. La sentencia if

Jos Alberto San Juan San Agustin

Pgina 5

Universidad Politcnica de Tulancingo

If (condicion) { sentencias; } 2. la sentencia if-else if (condicion) { sentencias; }else{ Sentencias; } 3. Sentencia if else-if else If(condicion) { Sentencia; } else if (condicion) { Sentencia; } else { sentencia } 4. For La sentencia for debe tener la siguiente estructura: For(inicializacin;condicin;actualizacion){ Sentencias; }

Jos Alberto San Juan San Agustin

Pgina 6

Universidad Politcnica de Tulancingo

5. While La sentencia while debe tener la siguiente estructura. While (condicion) { Sentencias; } 6. Do-while La sentencia do-while debe tener la siguiente estructura: do { sentencias } while(condicion) 7. switch Este debe tener la siguiente estructura. switch (condicion) { case ABC: sentencias; break; case DEF: sentencias; break; default: sentencias; break; }

Jos Alberto San Juan San Agustin

Pgina 7

Universidad Politcnica de Tulancingo

8. Try-catch Debe contener la siguiente estructura: try { sentencias; } catch(ExceptionClass e) { Sentencias; } Espacios en Blanco Son fundamentales en la lectura del cdigo empleado en el programa. Lneas en Blanco. Las lneas de cdigo separan secciones de cdigo de la siguiente manera: 01. Una lnea Entre los mtodos Antes de un comentario de bloque o de una lnea 02. Dos lneas Entre secciones de un archivo fuente Entre las definiciones de clases e interfaces Espacios en blanco Los espacios en blanco separan elementos dentro de las lneas de cdigo, as: o o o o Palabra clave seguida de parntesis, no aplica para los mtodos Despus de cada coma (,) en una lista de argumentos Antes y despus de cada operador excepto el . y los de incremento o decremento. En las expresiones dentro de un for.

Convenciones de nombres Ayudan a comprender un programa, ya que el nombre suministra informacin acerca de la funcin de un identificador.

Jos Alberto San Juan San Agustin

Pgina 8

Universidad Politcnica de Tulancingo

Clases e interfaces A la hora de nombrar una clase o una interfaz se debe tener en cuenta los siguientes aspectos: -Nombre debe ser un Sustantivo. -Si es compuesto, cada palabra debe ser con mayscula inicial. -Nombre simple y descriptivo -Evitar abreviaturas

Ejemplo: class Pelicula class RegistroPelicula

interface VideoTienda interface Proveedor Mtodos

A la hora de nombrar un mtodo se tomaran en cuenta los siguientes aspectos. El nombre deber ser en la medida de lo posible un verbo. Si el nombre es simple se escribe en minscula. Si es compuesto, la primera se inicia con minscula y la segunda con mayscula.

Ejemplos String leerLinea(); void guardar();

Variables A la hora de nombrar una variable se tomaran en cuenta los siguientes aspectos.

Jos Alberto San Juan San Agustin

Pgina 9

Universidad Politcnica de Tulancingo

o o o o Se escribe en minscula Si es compuesta, la primera inicia con minscula y la segunda con mayscula Evitar nombres de un solo carcter, excepto para variable ndices (i,j) Nombre corto y con significado

Ejemplos: String nombre; Int tipoPelicula;

Constantes Para esto se deben tener en cuenta la siguiente lista de aspectos. o o Se escribe en minscula Si es compuesta, la primera inicia con minscula y la segunda con mayscula Ejemplos: static final int doubl iva=0.16;

Referencia www.aves.edu.co/ovaunicor/recursos/view/265

Jos Alberto San Juan San Agustin

Pgina 10