standares de programacion
Content
Fuentes : http://es.wikipedia.org/wiki/Estilo_de_programaci%C3%B3n http:// proyectos.masterlex.com/.../ING-01-MLX%20%20Estandares%20de %20Programacion.doc http://www.desarrolloweb.com/articulos/2358.php http://es.wikipedia.org/wiki/Lenguaje_de_alto_nivel
Estándares de programación es un término que describe convenciones para escribir código fuente en ciertos lenguajes de programación. El estándar de programación es frecuentemente dependiente del lenguaje de programación que se haya elegido para escribir. Por ejemplo el estilo del lenguaje de programación C variará con respecto al del lenguaje BASIC. Características del estilo El buen estilo, al tratarse de algo subjetivo, es difícil de categorizar concretamente; con todo, existen un número de características generales. Con el advenimiento de software que da formato al código fuente de forma automática, el foco en cómo éste debe de ser escrito debe evolucionar de forma más amplia a la elección de nombres, lógica y otras técnicas. Desde un punto de vista práctico, el uso de un computador para dar formato al código fuente ahorra tiempo, y es posible forzar el uso de estándares a nivel de una compañía completa sin debates religiosos. Los lenguajes más próximos a la arquitectura hardware se denominan lenguajes de bajo nivel y los que se encuentran más cercanos a los programadores y usuarios se denominan lenguajes de alto nivel. Lenguajes de bajo nivel Se llaman de bajo nivel porque están muy cercanos al hardware del ordenador. Es necesario conocer a fondo la arquitectura de la maquina para la que se va a programar. El primer lenguaje de este tipo que se utilizó fue el lenguaje máquina, que consiste en un conjunto de instrucciones en binario, es decir, con ceros y unos, con los cuales se indica al ordenador qué hacer. Este lenguaje es muy complicado y la posibilidad de cometer errores es muy alta, por lo que ya no se utiliza. Para solventar estas dificultades aparecio el lenguaje ensamblardor, que consiste en asignar una abreviatura a cada instrucción en binario, de forma que sea más fácil recordarla y más difícil equivocarse. Sin embargo, con este lenguaje sigue siendo necesario conocer muy bien el hardware del ordenador. Dentro de este grupo se encuentran:
•
•
El lenguaje maquina: este lenguaje ordena a la máquina las operaciones fundamentales para su funcionamiento. Cnsiste en la combinación de 0's y 1's para formar las ordenes entendibles por el hardware de la maquina. Este lenguaje es mucho más rápido que los lenguajes de alto nivel. La desventaja es que son bastantes difíciles de manejar y usar, además de tener códigos fuente enormes donde encontrar un fallo es casi imposible. El lenguaje ensamblador es un derivado del lenguaje maquina y esta formado por abreviaturas de letras y números llamadas mnemotécnicos. Con la aparición de este lenguaje se crearon los programas traductores para poder pasar los programas escritos en lenguaje ensamblador a lenguaje máquina. Como ventaja con respecto al código máquina es que los códigos fuentes eran más cortos y los programas creados ocupaban menos memoria. Las desventajas de este lenguaje siguen siendo prácticamente las mismas que las del lenguaje ensamblador, ñadiendo la dificultad de tener que aprender un nuevo lenguaje difícil de probar y mantener.
Lenguaje de alto nivel Un lenguaje de programación de alto nivel se caracteriza por expresar los algoritmos de una manera adecuada a la capacidad cognitiva humana, en lugar de a la capacidad ejecutora de las máquinas. En los primeros lenguajes de alto nivel la limitación era que se orientaban a un área específica y sus instrucciones requerían de una sintaxis predefinida. Se clasifican como lenguajes procedimentales. Otra limitación de los lenguajes de alto nivel es que se requiere de ciertos conocimientos de programación para realizar las secuencias de instrucciones lógicas. Los lenguajes de alto nivel se crearon para que el usuario común pudiese solucionar un problema de procesamiento de datos de una manera más fácil y rápida. Por esta razón, a finales de los años 1950 surgió un nuevo tipo de lenguajes de programación que evitaba estos inconvenientes, a costa de ceder un poco en las ventajas. Estos lenguajes se llaman de tercera generación o de alto nivel, en contraposición a los de bajo nivel o de nivel próximo a la máquina. Principales lenguajes de alto nivel
• • • • • • • •
Ada ALGOL BASIC C++ C# COBOL Fortran Java
• • • • • • •
Lisp Modula-2 Pascal Perl PHP PL/SQL Python
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. <nombre de la capa><Nombre> 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. <Nombre> Los nombre de los procedimientos deben de llevar la primera letra de cada palabra en mayúscula y unidas.
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 área 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’ Variables Las variables dependiendo de su alcance se dividen en globales y locales, el nombre de la variable consta de un prefijo seguido del nombre de la variable definido por el consultor. El nombre debe de tener la siguiente sintaxis: <ubicación><tipo de dato>_<nombre de la variable> Los prefijos son los siguientes:
Alcance: • Global (g) • Local (l) , todas las variables locales pueden omitir el uso de este prefijo Tipo de Dato Nombre String Char Boolean Numerico Integer Long List Array Objeto DateTime Date Time Multiclase Collection • … Prefijo s c b n i l lst arr obj dt dt dt m cl
Como el nombre de la variable lo va a definir el consultor, debe ser lo más claro posible, dejando a entender el valor del mismo. Si el nombre de la variable consta de varias palabras, debemos de digitar las palabras unidas como nombre de la variable, las palabras deben tener su primera letra en mayúscula, excepto la primera palabra. Por ejemplo: Si vamos a necesitar una variable que va a contener un primer nombre (dos palabras) de una persona, debe ser como el siguiente ejemplo: lsNombreEmpleado Si necesitamos crear una variable que va a contener un estado (una palabra), debe ser como el siguiente ejemplo: 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 Label TextBox ComboBox ListBox DialogBox Option Checkbox Visual Basic Form Visual Basic Module Visual Basic Class Command Button
Prefijo Lb Txt Cb Lst dlg Op Ch frm mod cl cmd
Documentación interna
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. 1. 2. 3. 4. Inicia en mayúscula. Identifica claramente el contenido. Es en español. Inicia con un verbo.
Ejemplo ObtenerCodigoFicha () ImprimirDocumento () VerificarCodigosAceptados ()
Estándares de programación es un término que describe convenciones para escribir código fuente en ciertos lenguajes de programación. El estándar de programación es frecuentemente dependiente del lenguaje de programación que se haya elegido para escribir. Por ejemplo el estilo del lenguaje de programación C variará con respecto al del lenguaje BASIC. Características del estilo El buen estilo, al tratarse de algo subjetivo, es difícil de categorizar concretamente; con todo, existen un número de características generales. Con el advenimiento de software que da formato al código fuente de forma automática, el foco en cómo éste debe de ser escrito debe evolucionar de forma más amplia a la elección de nombres, lógica y otras técnicas. Desde un punto de vista práctico, el uso de un computador para dar formato al código fuente ahorra tiempo, y es posible forzar el uso de estándares a nivel de una compañía completa sin debates religiosos. Los lenguajes más próximos a la arquitectura hardware se denominan lenguajes de bajo nivel y los que se encuentran más cercanos a los programadores y usuarios se denominan lenguajes de alto nivel. Lenguajes de bajo nivel Se llaman de bajo nivel porque están muy cercanos al hardware del ordenador. Es necesario conocer a fondo la arquitectura de la maquina para la que se va a programar. El primer lenguaje de este tipo que se utilizó fue el lenguaje máquina, que consiste en un conjunto de instrucciones en binario, es decir, con ceros y unos, con los cuales se indica al ordenador qué hacer. Este lenguaje es muy complicado y la posibilidad de cometer errores es muy alta, por lo que ya no se utiliza. Para solventar estas dificultades aparecio el lenguaje ensamblardor, que consiste en asignar una abreviatura a cada instrucción en binario, de forma que sea más fácil recordarla y más difícil equivocarse. Sin embargo, con este lenguaje sigue siendo necesario conocer muy bien el hardware del ordenador. Dentro de este grupo se encuentran:
•
•
El lenguaje maquina: este lenguaje ordena a la máquina las operaciones fundamentales para su funcionamiento. Cnsiste en la combinación de 0's y 1's para formar las ordenes entendibles por el hardware de la maquina. Este lenguaje es mucho más rápido que los lenguajes de alto nivel. La desventaja es que son bastantes difíciles de manejar y usar, además de tener códigos fuente enormes donde encontrar un fallo es casi imposible. El lenguaje ensamblador es un derivado del lenguaje maquina y esta formado por abreviaturas de letras y números llamadas mnemotécnicos. Con la aparición de este lenguaje se crearon los programas traductores para poder pasar los programas escritos en lenguaje ensamblador a lenguaje máquina. Como ventaja con respecto al código máquina es que los códigos fuentes eran más cortos y los programas creados ocupaban menos memoria. Las desventajas de este lenguaje siguen siendo prácticamente las mismas que las del lenguaje ensamblador, ñadiendo la dificultad de tener que aprender un nuevo lenguaje difícil de probar y mantener.
Lenguaje de alto nivel Un lenguaje de programación de alto nivel se caracteriza por expresar los algoritmos de una manera adecuada a la capacidad cognitiva humana, en lugar de a la capacidad ejecutora de las máquinas. En los primeros lenguajes de alto nivel la limitación era que se orientaban a un área específica y sus instrucciones requerían de una sintaxis predefinida. Se clasifican como lenguajes procedimentales. Otra limitación de los lenguajes de alto nivel es que se requiere de ciertos conocimientos de programación para realizar las secuencias de instrucciones lógicas. Los lenguajes de alto nivel se crearon para que el usuario común pudiese solucionar un problema de procesamiento de datos de una manera más fácil y rápida. Por esta razón, a finales de los años 1950 surgió un nuevo tipo de lenguajes de programación que evitaba estos inconvenientes, a costa de ceder un poco en las ventajas. Estos lenguajes se llaman de tercera generación o de alto nivel, en contraposición a los de bajo nivel o de nivel próximo a la máquina. Principales lenguajes de alto nivel
• • • • • • • •
Ada ALGOL BASIC C++ C# COBOL Fortran Java
• • • • • • •
Lisp Modula-2 Pascal Perl PHP PL/SQL Python
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. <nombre de la capa><Nombre> 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. <Nombre> Los nombre de los procedimientos deben de llevar la primera letra de cada palabra en mayúscula y unidas.
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 área 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’ Variables Las variables dependiendo de su alcance se dividen en globales y locales, el nombre de la variable consta de un prefijo seguido del nombre de la variable definido por el consultor. El nombre debe de tener la siguiente sintaxis: <ubicación><tipo de dato>_<nombre de la variable> Los prefijos son los siguientes:
Alcance: • Global (g) • Local (l) , todas las variables locales pueden omitir el uso de este prefijo Tipo de Dato Nombre String Char Boolean Numerico Integer Long List Array Objeto DateTime Date Time Multiclase Collection • … Prefijo s c b n i l lst arr obj dt dt dt m cl
Como el nombre de la variable lo va a definir el consultor, debe ser lo más claro posible, dejando a entender el valor del mismo. Si el nombre de la variable consta de varias palabras, debemos de digitar las palabras unidas como nombre de la variable, las palabras deben tener su primera letra en mayúscula, excepto la primera palabra. Por ejemplo: Si vamos a necesitar una variable que va a contener un primer nombre (dos palabras) de una persona, debe ser como el siguiente ejemplo: lsNombreEmpleado Si necesitamos crear una variable que va a contener un estado (una palabra), debe ser como el siguiente ejemplo: 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 Label TextBox ComboBox ListBox DialogBox Option Checkbox Visual Basic Form Visual Basic Module Visual Basic Class Command Button
Prefijo Lb Txt Cb Lst dlg Op Ch frm mod cl cmd
Documentación interna
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. 1. 2. 3. 4. Inicia en mayúscula. Identifica claramente el contenido. Es en español. Inicia con un verbo.
Ejemplo ObtenerCodigoFicha () ImprimirDocumento () VerificarCodigosAceptados ()
