¡Descarga Estandares de programacion y más Guías, Proyectos, Investigaciones en PDF de Introducción a Ingeniería Software solo en Docsity!
Desarrollo de Proyectos -
Convenciones o estándares de Programación Código de Aplicaciones Dentro de la aplicación ya sea Windows o Web, vamos a tener distintos tipos de objetos, pueden ser: variables, constantes, procedimientos, etc.; los nombres de los mismos estarán compuestos de un prefijo seguido del nombre del objeto. Clases Los nombres de las clases deben de poseer un prefijo en conjunto con el nombre propio de la clase. El nombre de la clase debe ser especificado por el consultor a cargo de su creación, debe de poseer un nombre significativo. El nombre debe de estar en singular. Nombre de la Capa: Por ejemplo: Objeto (cl) Multi-Objeto (mo) Base Datos(bd) Webforms (wf) Por ejemplo: Si queremos crear una clase que contenga los procedimientos necesarios para traer los datos de la tabla de usuarios, el nombre debe ser algo similar a: clUsuarios Procedimientos Los nombres de los procedimientos deben de contener un conjunto de prefijos seguido del nombre del mismo. Los nombre de los procedimientos deben de llevar la primera letra de cada palabra en mayúscula y unidas.
Departamento de Desarrollo de Proyectos - Masterlex
Versión 1.
Constantes Las constantes se dividen en globales y locales, el nombre de la constante posee un prefijo seguido del nombre de la constante definido por el consultor. Los nombres de constantes siempre se escribirán en MAYUSCULA Los nombres de constantes deben iniciar con un prefijo que encapsule el módulo o area del programa, por ejemplo FILEMASTER – FM- Como el nombre de la constante lo va a definir el consultor, se debe de ser lo más descriptivo posible, dejando a entender el valor del mismo. Si el nombre de la constante esta compuesta de varias palabras, debemos de digitar las palabras unidas como nombre de la constante, las palabras deben tener su primera letra en mayúscula, excepto la primera palabra. Por ejemplo: Si vamos a necesitar una constante que va a contener un primer nombre (dos palabras) de una persona, debe ser como el siguiente ejemplo: PRIMER_NOMBRE FM_AGREGAR_REGISTRO FM_FICHA_CAMPO_NUMERICO FM_ESTADO_ACTIVO = ‘A’
Departamento de Desarrollo de Proyectos - Masterlex
Versión 1.
lsEstado o sEstado Posición dentro del Código Fuente Todas las variables sin distinción deben quedar declaradas en al cabecera o header del procedimiento, función o evento. A pesar que el código fuente permita otra acción se requiere que todas queden declaradas en la posición indicada. Ejemplo Function XYZ Dim nI As Integer = 1 Dim nAncho As Integer = 500 Dim nAlto As Integer = 400 Un mal ejemplo Function XYZ Dim nI As Integer = 1 Dim nAncho As Integer = 500 If llamarDatos() then endif Dim nAlto As Integer = 400 Controles Visuales Los controles visuales deben poseer un nombre estandar, el cual se identificara con un prefijo todo en minuscula, seguido por el nombre del control. Nombre Prefijo Label Lb TextBox Txt ComboBox Cb ListBox Lst DialogBox dlg Option Op Checkbox Ch Visual Basic Form frm Visual Basic Module mod Visual Basic Class cl Command Button cmd Documentación interna
Departamento de Desarrollo de Proyectos - Masterlex
Versión 1.
Procedimientos y Funciones Para la declaración de los procedimientos debemos de seguir el siguiente estándar para los mismos.
NOMBRE: FECHA Y CREADOR: DESCIPCION DETALLE: MODIFICACION
Este encabezado debe ser agregado una línea antes de iniciar el procedimiento o la función. Código fuente comentado Se entiende como código fuente comentado aquellas líneas de código fuente que fueron puestas entre comentarios por fines de reemplazo de código. Este código comentado no tiene funcionalidad alguna dentro del sistema por lo tanto debe ser eliminado por completo del mismo, solo en casos excepcionales Por ejemplo 'cargarSegundoCampo() '´' Me.cmdCondicionVariable.Enabled = False ' cmdSegCampos.Enabled = False Las anterior líneas comentadas no deben pertenecer al código fuente estable que se usará para realizar una compilación. Esta virtud de programación será altamente evaluada durante el proceso de auditoria. Nombre de las funciones y procedimientos El nombre de una función o procedimiento debe contener las siguientes especificaciones.
- Inicia en mayúscula.
- Identifica claramente el contenido.
- Es en español.
- Inicia con un verbo. Ejemplo ObtenerCodigoFicha () ImprimirDocumento () VerificarCodigosAceptados ()
