Estandar de codificacion PSP

ESTANDAR DE CODIFICACION

Mediante el estándar de codificación descrito a continuación permitirá de forma rápida, fácil y sencilla comprender el código empleado para el desarrollo de la aplicación para el control de visitas genérico a un edificio residencial o comercial.
También garantiza un fácil y optimo mantenimiento del código por parte del programador.

1. ARCHIVOS

1. Nombres: Para los nombres se establecen las siguientes convenciones:

-Los archivos creados en java tienen la extensión .java

-Los nombres de los archivos deben ser claros simples y descriptivos

Ejemplo:

ControlDeVisitas.java

PantallaDeRegistro.java

1.  ORGANIZACIÓN
   a) Package e import: Son las primeras líneas de la clase y esta puede llevar tantas sentencias import como sean necesarias

Ejemplo:
package controldevisitas;
import java.util.Date;
import java.sql.*;
import javax.swing.JTextField;

1. Declaración de clases: Se establece las parte y el orden en las que estas deben ser descritas como se describe a continuación:
   -Sentencia class o interface

-Variables de clase

-Constructores

-Métodos

1. IDENTACION: Esta se usar para mejorar la legibilidad del código fuente y la fácil identificación de aperturas y cierres en condicionales y ciclos.
   Se usa 1 TAB como unidad de identacion.}

1. INICIALIZACION: Es la asignación de valores iniciales a variables. Al declararlas se hace necesarias inicializarlas en el lugar en que han sido declaradas.
   Si la variable es de tipo String se inicializa en vacio con comillas “”
   Si la variable es de tipo integer se inicializa con el valor 0

1. SENTENCIAS: Se recomienda que cada línea contenga una sola sentencia.

1. CONVENCION DE NOMBRES
   a) Clases e interfaces:
      -El nombre debe ser sustantivo
      -Si es compuesto cada palabra debe de llevar mayúscula inicial
      -Nombre simple y descriptivo
   

1. Métodos
   -El nombre debe de ser un verbo
   
2. Variables:

-Se escribe con mayúscula inicial

-Si es compuesta la palabra la palabra que sigue se escribe con mayúscula inicial y no debe de llevar ningún carácter especial como separador.

-Evitar nombres de un solo carácter, excepto para variables índices.

...