You are on page 1of 3

Estndar de Codificacin

Gua para codificar programas en Java, Basada en el Java Code Conventions


Propsito de Oracle http://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc136057.html

Todos los archivos fuente deben comenzar con comentarios estilo c que
Encabezado del Programa

enlisten el nombre de la clase, informacin de la versin, fecha e informacin de Copyright (si la hay). empresa) y nombre del curso.

Alternativamente para este curso se agregaran 2 detalles mas, institucin (o


/* * Nombre de la Clase * * Informacin de la versin * * Fecha * * Informacin de Copyright * * Instituto o empresa * * Nombre del curso * */

Formato del encabezado

Paquetes y sentencias import Formato de paquetes y sentensias import Indentacin Formato de indentacin Tamao de lneas

La primera lnea no comentada debe ser el paquete al que pertenece la clase, despus del paquete siguen sentencias import
package java.awt; import java.awt.peer.CanvasPeer; Debern ser usados 4 espacios como unidad de identacin usando el tabulador. public class Clase { public static void main(String args[]) { System.out.println(Hola mundo); } } Evitar usar lneas mas largas de 80 caracteres function(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5); var = function1(longExpression1, function2(longExpression2, longExpression3)); someMethod(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAnother) { ... } Para comentar varias lneas de cdigo se utilizan los comentarios de bloque, para una sola lnea se utilizan los de final de lnea.

Formato de tamao de lneas

Comentarios

Estndar de Codificacin
/* * Este es un comentario en bloque * sirve para comentar varias * en lneas */

Formato de comentarios

if (condicion) { /* Tambien se pueden utilizar para una sola lnea*/ ... } // comentarios de fin de lnea. Los nombres de las variables deben de ser claras de acuerdo a su significado. int altura; int anchura; // anchura de una caja // altura de una caja

Declaraciones de variables Formato de declaracion de variables

Mtodos

Formato de mtodos

Convencion de nombres

Cuando se declaran clases e interfaces se deben seguir las siguientes reglas: Sin espacios entre el nombre del mtodo y los parntesis Los espacios en blanco solo se dejaran cuando se anteponga una palabra reservada (for, if, while, etc). La llave de apertura deber ir en la misma lnea de la declaracin. La llave de cierre deber ir en la misma indentacin que la llave de apertura Si el mtodo esta vaco escribir la llave de cierre justo despues de la llave de apertura. While (true) { . . . . } ejemplo(int i, int j) { ivar1 = i; ivar2 = j; } int metodoVacio() {} Clases: debern ser sustantivos y se declararan en camel case (cada palabra inicia con mayscula). Interfaces: igual que las clases. Mtodos: los mtodos debern ser verbos y se escribir la primera palabra en minsculas y si contiene mas se aplicara camel case. Variables: se escribirn en minsculas. Constantes: se escriben en maysculas sin excepcin. class Gato; class AvionPivado; interface Jumbo;

Formato de Nombres

int inicial; String nombre; int TAMANO_MAXIMO = 100;

Sentencias Formato de sentencias Sentencias if, else if, else.

Cada lnea debe contener solo una sentencia. argv++; argc--; Como son palabras reservadas debe haber espacio en antes de los parntesis, as como sus llaves de apertura y cierre.

Estndar de Codificacin
if (condition) { sentencias; } else if (condition) { sentencias; } else { sentencias; } Igual que las sentencias if debe tener espacio antes de los parntesis y llaves. for (inicializacion; condicion; incremento) { sentencias; } while (condicion) { sentencias; } do { sentencias; } while (condicion); En las sentencias switch siempre debe de haber un caso default y aunque los break son redundantes deben de incluirse para evitar que ejecuten los casos en cascada, en caso de no hacerlos comentarlo. switch (condicion) { case ABC: sentencias; /* ejecucin en cascada */ case DEF: sentencias; break; case XYZ: sentencias; break; default; sentencias; break; } Cada try puede contener varias sentencias catch, en las sentencias catch siempre usar las excepciones especificas. try { sentencias; } catch (ExceptionClass e) { sentencias; }

Formato de sentencias if, else if, else. Sentencias for, while, do while.

Formato de sentencias for, while, do while.

Sentencias switch

Formato de sentencias switch.

Sentencias try y catch Formato de sentencias try y catch Cuantificacin de Lneas de Cdigo

Para este caso la cuantificacin ser muy simple: Total = Suma de Lneas Totales (Lneas en blanco + Lneas de comentarios)