Estándar Para Código De Proyectos Web

Estándar para Código de Proyectos Web

Índice

Nombres de Objetos y Variables 2
Archivos .vb 3
Funciones y Métodos 4
Orden y Formato 5
Uso de variables y objetos 6
Base de Datos 7Propósito

El propósito de este documento es proporcionar al programador de aplicaciones Web lineamientos que le permitan el desarrollo de código eficiente y ordenado, pero principalmente vanorientados a que el mantenimiento pueda realizarlo cualquier desarrollador de la manera más fácil y rápida posible.

Nombres de Objetos y Variables

El nombre de los objetos y variables debepermitir identificar su tipo y la información que contendrá. Esto contribuirá a que el desarrollador no invierta demasiado tiempo en su rastreo.
La estructura de los nombres de objetos y variablesserá tres letras minúsculas que identifiquen el tipo y la palabra que describa el contenido, iniciando con mayúscula. Si la descripción del contenido comprendiera más de una palabra, podránabreviarse sin que el nombre deje de ser entendible y cada una de ellas iniciará con mayúscula.
Los Form, WebForm, Class, Module y demás objetos que contengan el código del proyecto deberán iniciarcon dos letras minúsculas que identifiquen el nombre del proyecto seguidas de un guión bajo y continuando con la estructura ya descrita anteriormente.
No deberán utilizarse acentos, caracteresespeciales y la letra “ñ” con el fin de que puedan ser escritos con cualquier configuración del teclado.

Ejemplos:

1. Variable de tipo string que almacenará el nombre de un empleado:strNomEmpleado.
2. Variable de tipo entero que almacenará el año: intAnio.
3. Cuadro de texto que contendrá la ciudad: txtCiudad
4. Grid que contendrá una lista de productos: grdProductos
5. Pantalla paragenerar reportes: cp_frmReportes

Abreviaturas para Tipos
|Tipo |Abreviatura |Tipo |Abreviatura |
|Array...