Estándares de Desarrollo del Proyecto

Los estándares de desarrollo constituyen las normas o patrones de referencia que se deben implementar en el desarrollo de aplicaciones de software. Entre los estándares de desarrollo más comunes se encuentran: normas de codificación, normas y esquemas de seguridad, estándares de interfaz u/s, entre otros.

MAPA INDUSTRIAL DE VENEZUELA

SISTEMA PARA LA SIMULACIÓN DE ESCENARIOS.

Estándares de D'esarrollo del Proyecto

Proceso	Tipo de documento	Versión del <<BR>>documento	Versión de la <<BR>>aplicación<<BR>>	Responsable	Fecha de elaboración
Administración de Proyectos de Software	Estándares de<<BR>>desarrollo del Proyecto	1.0	1.0	Erwin Paredes<<BR>>	25/04/2013

Licencia de Uso

Copyright (c), 2007, CENDITEL.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

Una copia de la licencia puede obtenerse en los ficheros llamados “copyrigh.txt" en ingles, “copyrigh.es.txt" en español o en los siguientes sitios en Internet:

• ​http://www.gnu.org/copyleft/fdl.html
• ​http://www.fsf.org/licensing/licenses/fdl.html

Historial de Revisiones

Fecha	Versión	Descripción	Responsable(s)
25/04/2013	1.0	Versión inicial del documento	Erwin Paredes

Estándares de D'esarrollo del Proyecto

Los estándares de desarrollo constituyen las normas o patrones de referencia que se deben implementar en el desarrollo de aplicaciones de software. Entre los estándares de desarrollo más comunes se encuentran: normas de codificación, normas y esquemas de seguridad, estándares de interfaz u/s, entre otros.

Dados los conocimientos adquiridos por parte de los desarrolladores en la programación en sistemas similares y sobre el proyecto de Mapa Industrial, se recomienda utilizar el lenguaje de programación C++, con el anexo de librerías de estándares del lenguaje.

Estándares iniciales para cada componente:

• Cada programa debe comenzar con un comentario que contenga:
  • Autor o autores
  • Fecha de creación
  • Objetivo o problema que resuelve el programa
  • Cada función debe contener:
  • Objetivo de la función
  • Comentario de apoyo sobre la variables utilizadas según su complejidad
  • Explicación del uso de parámetros o argumentos no obvios
  • Explicación de valor que retorna.

La indentación debe ser de cuatro (04) caracteres o espacios en blanco.

Nombre de los identificadores

Se considera como identificador a los nombres de variables (arreglos, matrices, apuntadores), funciones, así como cualquier tipo de dato definido por el usuario (estructura, clase). Dichos identificadores deberán seguir las siguientes normas, además de las definidas por el propio lenguaje.

• Deberán tener un nombre significativo para que por su simple lectura, pueda conocerse su función, sin tener que consultar manuales o hacer demasiados comentarios.
• Para nombres que se usen con frecuencia o para términos largos, se recomienda usar abreviaturas estándar para que éstos tengan una longitud razonable. Si usa abreviaturas deben manejar la misma lógica en todo el programa.
• Evitar identificadores que comiencen con uno o dos caracteres de subrayado para evitar que se confundan con los que el compilador selecciona.
• Cada identificador de función, variable o procedimiento deberá ser precedido por la abreviación del tipo de dato de que es la variable, o si se trata de una función o procedimiento del tipo de dato que regresa.
• Se establece como estándar los nombre para los contadores en estructuras de repetición: i, j, k
• Para el nombre de los archivos deben expresar el propósito intrínseco del contenido, sie el archivo contiene la definición de una clase el nombre del archivo de usar dicho nombre, se debe utilizar el estandar CamelCase, esto es palabras en conjunto la inicial en máyuscula y el resto en minúscula. Ejemplo: RegistrarUsuario?.cpp
• Los nombres de las clases deben ser sustantivos ejemplo: Usuaurio, UsuarioAdministrador?
• Para nombrar los métodos o funciones se debe utilizar verbos que representa la acción que ejecutan, debe estar en minúsculas, en caso de un nombre en compuesto la primera palabra en minúscula y la incial de la segunda palabra en mayúscula. Ejemplo: borrar(), borrarTodo().
• Para el nombre de las variables se sigue el estándar expuesto para nombrar los métodos.
• La constates debe ser declaradas en mayúsculas y si están conformadas por dos o más palabras debe ser separadas con un underscore ( _ ). Ejemplo: VALOR_CONSTANTE =

Como mejores prácticas para la codificación se recomienda:

• Evitar líneas mayores de 80 caracteres.
• Realizar un salto de línea para cada instrucción cuyo separador es el “;"
• Para los bloques de instrucciones se debe conservar la jerarquía de alto nivel, esto es, el bloque con la indentación recomendada más a la derecha que el padre.
• Se debe colocar solo una declaración de variables por línea, y las variables locales debe ser inicializadas cuando se declaren.
• Se recomienda evitar en lo posibles hacer declaración de atributos públicos o privados, todos deben ser privados y deben construirse métodos para acceder a los mismos.
• Se recomienda no utilizar número directamente en las operaciones, se recomienda utilizar constantes. Ejemplo total = precio * IVA;
• No utilizar asignaciones embebidas. Ejemplo a = (b = c + d);
• Se recomienda dejar un espacio en blanco después de cada coma en la declaración y llamado para el pase de parámetros en los métodos.
• Insertar una línea en blanco antes y después de la declaración de variables.
• Los operadores unarios (++, -- , etc) deben colocarse al lado de sus operarios sin espacios en blanco.
• Para hacer más clara una expresión, es aceptable agregarle paréntesis innecesarios. Dichos paréntesis se llaman paréntesis redundantes.

Todas los anteriores estándares se presentan como buenas prácticas producto de la experiencia y de los estándares estipulados por la organización ISO/IEC 9899:1999, mas preciso del: Borrador de Trabajo. Estandares de Programación, Lenguaje C++" revisión N3337 del 16 de Enero del 2012.