Normas De Desarrollo

Normas de desarrollo

Indice

Nomenclatura de archivos.............................................................................1 Capa gráfica (GUIs).......................................................................................2 Capa de control (servlets y .java)..................................................................3 Capa bean......................................................................................................4

Nomenclatura de archivos Dado que para el desarrollo del sistema se requirió que se utilizara la plataforma JEE, en donde se divide el desarrollo de la aplicación en a lo menos dos capas, entre la capa bean y las que no lo son. La idea es estructurar el desarrollo del sistema correspondiente a la capa de programación (excluyendo a la base de datos) en 3 capas, la capa web, la capa de control y la capa bean. Un ejemplo de lo que se describe se representa en la siguiente figura:

1

Para diferenciar cada una de ellas se utilizara la nomenclatura descrita a continuación. Capa gráfica (GUIs) El nombre de cada archivo tendrá un prefijo “f”,esto indicara a futuros desarrolladores que es un formulario (esto es para quienes recién comienzan con la plataforma JEE y los .jsp), y su nombre estará escrito en minúscula, siguiendo el común de los sitios web, si el nombre del .jsp esta compuesto por dos o mas palabras estas irán anidadas. Su nomenclatura sera la siguiente: fnombredeloquerepreseta.jsp Un ejemplo es si se desea ingresar las vacaciones de un trabajador, para ello debemos crear un formulario, entonces este tendría por nombre, fingresovacaciones.jsp.

2

Capa de control (servlets y .java) El nombre de cada archivo tendrá el prefijo “C”, esto indicara a futuros desarrolladores que se trata de una clase de control y si este es un servlet debe llevar el sufijo “Servlet”, ademas el primer carácter de cada palabra sera escrito en mayúscula, si el nombre de la clase o servlet esta compuesto por dos o mas palabras estas irán anidadas como se menciona mas abajo. Para una clase java: CNombreDescriptivoDeLoQueControla.java Un ejemplo es una clase que controle todas las acciones que se realicen con un trabajador, esto seria, CTrabajadores.java 2. Para un sevlets: CNombreDescriptivoDeLoQueControlaServlet.java Un ejemplo es un servlet que controle el upload de archivos. esto es, CUploadFileServlet.java

3

Capa bean El nombre de cada bean sera escrito con la primera letra de la palabra en mayúscula y todas las demás en minúscula, al igual que los demás nombres descritos anteriormente, si el nombre esta compuesto por dos o más palabras, estas serán anidadas, también debe ir con un sufijo “Bean”, que lo agrega automáticamente en NetBeans. El nombre del bean debe corresponder o tener relación con las tablas que el bean manipula. Lo anterior seria: NombreRelacionadoconlaTablaBean.java Un ejemplo seria un bean que tenga acceso a la tabla Trabajador de la base de datos, entonces: TrabajadorBean.java En relación a la creación de los nombre de los métodos de cada archivo, se dejara a criterio de los programadores, pero tendrán que describir brevemente que realiza cada método y sus parámetros de entrada y salida

4