Documento de Estndares de Programacin

Version 1.0

Sistema Documento de Estndares de Programacin

Versin:

1.0

Historial de Revisiones
tem 1 Fecha 05/09/2011 Versin 1.0 Descripcin Versin Preliminar Autor Alejandro Javier Rossi, Jaime Tapia

Grupo 04

Sistema Documento de Estndares de Programacin

Versin:

1.0

Tabla de Contenido
1. 2. 3. 4. 5. 6. Introduccin .......................................................................................................................................... 4 Referencias............................................................................................................................................ 4 Convencin de Nombres de Controles ................................................................................................. 4 Conveccin de Nombres para Tipos de Datos ...................................................................................... 5 Conveccin de Nombres para Objetos de Conexin a la Base de Datos .............................................. 5 Convencin de Nombres de espacios de nombre ................................................................................ 6

Grupo 04

Sistema Documento de Estndares de Programacin

Versin:

1.0

Estndares de Programacin
1. Introduccin
El propsito del presente documento es la de usar un conjunto de convenciones de cdigo; de manera que, se estandarice la estructura y el estilo de codificacin de una aplicacin. De esta manera, el cdigo generado pueda ser ledo y entendido de manera sencilla. El presente documento es una adaptacin de la convencin de codificacin de Java (Java Code Conventions).

2. Referencias
Java Code Conventions, Sun Microsystems, 1997. The JavaTM Language Environment, Sun Developer Network.

3. Convencin de Nombres de Controles

Los controles que se utilizarn debern ser nombrados con un prefijo consistente que permita identificar rpidamente el tipo de objeto. La convencin que se utilizar es la siguiente:

Convencin de Nombres de Controles Tipo de Control Prefijo Ejemplo

JButton JCheckBox JComboBox JDesktopPane JDialog JFrame JInternalFrame JLabel JMenu JMenuBar JMenuItem JOptionPane JPanel JProgressBar btn cbx cmb dsk dlg frm itf lbl mnu mnub mnui op pnl pgb btnAceptar cbxDocumento cmbDepartamento dskEscritorio dlgMensaje frmPrincipal itfOperador lblMenu menu mnubBarraMenu mnubiItemMenu opPane1 pnlLogin pgbInicio

Grupo 04

Sistema Documento de Estndares de Programacin

Versin:

1.0

Convencin de Nombres de Controles Tipo de Control Prefijo Ejemplo

JRadioButton JScrollBar JTable JTextArea JTextField JTextPane JToolBar JToolTip rdb scb tbl txtar txtfld txtp tlb tlt rdbSexo scbBarra tblRacks txtarTexto1 txtfldCampo1 txtpTextNom tblBarra tltError

4. Conveccin de Nombres para Tipos de Datos

Para los siguientes tipos de datos se tendrn los correspondientes nemnicos:

Convencin de Nombres de Tipos de Datos Tipo de Dato Prefijo Ejemplo

byte short int long float double char boolean constante byt sh int lng flt dob chr bool CST+ MAYUSCULAS bytEstado shCantidad intContador lngDistancia fltMontoTotal fltPoblacion chrSexo boolEncontrado CSTIGV

5. Conveccin de Nombres para Objetos de Conexin a la Base de Datos

Para los objetos JDBC se utilizarn la siguiente convencin de nombres para los prefijos:

Objetos de la Base de Datos Clase

DriverManager Connection Statement ResultSet dm con stmt rs

Prefijo

Ejemplo
dm conConexion stmtAgregar rsResultado

Grupo 04

Sistema Documento de Estndares de Programacin

Versin:

1.0

6. Convencin de Nombres de espacios de nombre

Business Entity (BE) Son las clases que son usadas en las transacciones. En este paquete se encuentran mtodos para obtener y modificar atributos de la clase; as como, el estado del objeto.

Data Access Object (DAO) Son las clases dedicadas para ejecucin de operaciones con la base de datos. Se usan las clases BE para realizar las transacciones.

Business Logic (BL) Son las clases que contienen los gestores que se encargan de procesar las clases del paquete BE.

Graphical User Interface (GUI) Son clases dedicadas a la interfaz del sistema y a la presentacin.

Espacios de Nombre Tipo de Clase

Business Entity Data Access Object Business Logic Graphical User

Sufijo
BE DAO BL GUI

Grupo 04