INFO: Microsoft Consulting Services convenciones de nomenclatura para Visual Basic

Es una buena idea establecer convenciones de nomenclatura para el código de Visual Basic. Este artículo proporciona las convenciones de nomenclatura utilizadas por Microsoft Consulting Services (MCS).

Este documento es un superconjunto de las convenciones de codificación de Visual Basic que se encuentra en Visual Basic "Guía del programador".

Nota: Los controles de terceros mencionados en este artículo están fabricados por proveedores independientes de Microsoft. Microsoft no otorga ninguna garantía, implícita o de otro tipo, respecto al rendimiento de estos controles o confiabilidad.

Convenciones de nomenclatura ayudan a los programadores de Visual Basic:

• estandarizar la estructura, codificación de estilo y la lógica de una aplicación.
• crear código precisa, legible y inequívoca el origen.
• ser coherente con otras convenciones de lenguaje (lo que es más importante, la Guía de programadores de Visual Basic y notación húngara de Windows de C estándar).
• ser eficiente de un tamaño de cadena y punto de vista mano de obra, permitiendo así una mayor oportunidad de más y más completo nombres de objeto.
• Defina los requisitos mínimos necesarios para realizar la anterior.

Establecer las opciones de entorno

Utilice Option Explicit. Declarar las variables todo para guardar el tiempo de programación reduciendo el número de errores causados por errores tipográficos (por ejemplo, aUserNameTmp frente a sUserNameTmp frente a sUserNameTemp). En el cuadro de diálogo Opciones de entorno, establezca la declaración de variable requerida en Sí. La instrucción Option Explicit requiere declarar todas las variables en el programa de Visual Basic. Guardar archivos como texto ASCII. Guardar formulario (.frm) y módulo (.BAS) archivos como texto ASCII para facilitar el uso de sistemas de control de versiones y minimizar los daños que pueden deberse a daños en el disco. Además, puede:

• utilizar su propio editor
• utilizar herramientas automatizadas, tales como grep
• crear herramientas CASE o generación de código para Visual Basic
• realizar análisis externo de su código de Visual Basic

Para que guarde siempre los archivos como texto ASCII, desde el cuadro de diálogo Opciones de entorno de Visual Basic, establezca la opción Guardar como formato predeterminado a texto.

Objeto convenciones de nomenclatura para objetos estándar

Las siguientes tablas definen los prefijos de nombre de objeto estándar de MCS. Estos prefijos son coherentes con los documentados en la Guía de programadores de Visual Basic.

Objeto convención de nomenclatura para objetos de base de datos

Nota: Utilizar un sufijo para consultas permite que cada consulta para ordenarse con su tabla asociada en diálogos de Microsoft Access (Agregar tabla, lista de tablas instantáneas).

Convenciones de nomenclatura de menú

Las aplicaciones utilizan con frecuencia una abundancia de controles de menú. Como resultado, necesita un conjunto de convenciones de nomenclatura diferente para estos controles. Los prefijos de control de menú deben extenderse más allá de la etiqueta inicial mnu agregando un prefijo adicional para cada nivel de anidamiento, con el título de menú final al final de la cadena de nombre. Por ejemplo: cuando se utiliza esta convención, todos los miembros de un grupo menú determinado se muestran junto a entre sí en el objeto desplegable cuadros de lista (de la ventana de código y la ventana de propiedades). Además, los nombres de control de menú Documente claramente los elementos de menú al que están conectados.

Convenciones de nomenclatura para otros controles

Para controles nuevos no enumerados anteriormente, intente idear un prefijo de tres caracteres único. Sin embargo, es más importante que desactive que al ceñirse a tres caracteres.

Para los controles derivados, como un cuadro de lista mejorada, amplían los prefijos anteriores por lo que no hay confusión sobre el control que realmente se utiliza. Normalmente también se añadirán al prefijo de una abreviatura de minúscula para el fabricante. Por ejemplo, una instancia del control creada desde el marco 3D podría Visual Basic Professional utiliza un prefijo de fra3d para evitar confusiones sobre qué control realmente se utiliza. Un botón de comando desde MicroHelp podría utilizar cmdm para diferenciarlo en el botón de comando estándar (cmd).

Controles de terceros

Cada control de terceros utilizado en una aplicación debe enumerarse en sección de comentario de información general de la aplicación, que proporciona el prefijo utilizado para el control, el nombre completo del control y el nombre del proveedor de software:

Variable y el nombre de rutina

Los nombres de variable y función tienen la siguiente estructura: <prefix><body><qualifier><suffix> prefijos:

Las siguientes tablas definen prefijos de nombre de variable y función que se basan en notación húngara C para Windows. Estos prefijos se deben utilizar con todas las variables y nombres de función. Uso de sufijos básicos antiguos (como % & #, etc.) son desaconsejado.

Variable y prefijos de nombre de función: Nota: los valores de la columna Converged representan los esfuerzos para reunir los estándares de nomenclatura para Visual Basic, Visual Basic para aplicaciones y Access Basic. Es probable que estos prefijos se convertirá en el futuro en los estándares de Microsoft en algún momento.

Ámbito y prefijos de uso: notación húngara es tan valioso en Visual Basic como en C. Aunque los sufijos de tipo Visual Basic lo indican el tipo de datos de una variable, no explican lo que se utiliza una variable o función para o cómo se puede obtener acceso a él. Éstos son algunos ejemplos: Indique cada uno de estos nombres de variables a un programador algo muy diferente. Esta información se pierde cuando el nombre de la variable se reduce a enviar %. Prefijos del ámbito como g y m también reducen el problema de contención de nombre especialmente en proyectos de varios programadores.

Notación húngara es también muy utilizado por los programadores de C de Windows y hace referencia continuamente en la documentación del producto de Microsoft y en libros de programación del sector. Además, el bono entre los programadores C y programadores que utilizan Visual Basic será mucho más fuerte como el impulso de ganancias C++ del sistema de desarrollo. Esta transición dará como resultado muchos programadores de Visual Basic mover a C para la primera vez y muchos programadores con frecuencia mover hacia delante y hacia atrás entre ambos entornos.

El cuerpo de variable y nombres de rutina

El cuerpo de una variable o el nombre de rutina debe utilizar mayúsculas y minúsculas mezcladas y debe ser tan largo como sea necesario para describir su finalidad. Además, los nombres de función deben comenzar con un verbo, como InitNameArray o CloseDialog.

Para términos utilizados con frecuencia o largos, se recomiendan mantener las longitudes de nombre razonable abreviaturas estándar. En general, los nombres de variables mayor de 32 caracteres pueden difíciles de leer en pantallas VGA.

Al utilizar abreviaturas, asegúrese de que sean coherentes en toda la aplicación. Cambiar aleatoriamente entre número y número dentro de un proyecto se conducir a confusión innecesario.

Calificadores de variable y nombres de rutina

Variables relacionadas y rutinas suelen utilizarse para administrar y manipular un objeto común. En estos casos, utilice calificadores estándar para etiquetar las variables derivadas y rutinas. Aunque poner el calificador después de que el cuerpo del nombre puede parecer un poco complicado (como en sGetNameFirst, sGetNameLast en lugar de sGetFirstName, sGetLastName) este ejercicio ayudará a listas de estos nombres juntos en la rutina de editor de Visual Basic, lo que el lógica y la estructura de la aplicación sea más fácil de entender el orden. En la tabla siguiente se definen los calificadores comunes y su significado estándar:

Tipos definidos por el usuario

Declarar tipos de definido por el usuario en mayúsculas con _TYPE anexado al final del nombre del símbolo. Por ejemplo: cuando declara una variable de instancia de un usuario define el tipo, agregar un prefijo al nombre de variable para el tipo de referencia. Por ejemplo:

Constantes de nomenclatura

El cuerpo de los nombres de constantes debe ser UPPER_CASE con caracteres de subrayado (_) entre palabras. Aunque constantes estándar de Visual Basic no incluyen información húngaro, prefijos como i, s, g y m puede ser muy útil para comprender el valor y el ámbito de una constante. Para los nombres de constantes, siguen las mismas reglas como variables. Por ejemplo:

Tipo de datos Variant

Si sabe que una variable siempre almacenar datos de un tipo determinado, Visual Basic puede controlar los datos más eficazmente si declara una variable de ese tipo.

Sin embargo, el tipo de datos variant puede ser muy útil al trabajar con bases de datos, mensajes, DDE u OLE. Muchas bases de datos permiten NULL como un valor válido para un campo. El código necesita distinguir entre NULL, 0 (cero), y "" (cadena vacía). Muchas veces, estos tipos de operaciones pueden utilizar una rutina de servicio genérico no es necesario conocer el tipo de datos que recibe para procesar o pasar en los datos. Por ejemplo: el sin embargo, son algunos inconvenientes al uso de variantes. Instrucciones de código que utilizan variantes a veces pueden ser ambiguas para el programador. Por ejemplo: los ejemplos anteriores sería mucho menos ambiguo y fáciles de leer, depurar y mantener si las rutinas de conversión de tipo de Visual Basic se utilizaron en su lugar. Por ejemplo:

Comentarios del código

Todos los procedimientos y funciones deben comenzar con un breve comentario que describe las características funcionales de la rutina (lo que hace). Esta descripción debería describir no los detalles de implementación (cómo lo hace) porque estos suelen cambian a lo largo del tiempo, lo trabajo de mantenimiento de comentario innecesarios o peor aún, comentarios erróneos. El propio código y los comentarios en línea o locales necesarios se describen la implementación.

Parámetros pasados a una rutina deben ser descritos cuando sus funciones no son obvias y cuando la rutina espera los parámetros en un intervalo específico. Función devolver valores y variables globales que han cambiado por la rutina (especialmente a través de los parámetros de referencia) también deben describirse al principio de cada rutina.

Comentario del encabezado rutina deben buscar bloques como este (consulte la sección siguiente "Formato el código" para obtener un ejemplo): cada declaración de variable no trivial debe incluir un comentario de en línea que describe el uso de la variable está declarada.

Las variables, controles y rutinas deben tener un nombre lo suficientemente claro para que comentarios en línea sólo es necesario para detalles de implementación complejas o no intuitivo.

Una descripción de información general de la aplicación, enumerar objetos de datos principal, rutinas y algoritmos, cuadros de diálogo, base de datos y archivo de dependencias del sistema y así sucesivamente deben ser incluida al principio del módulo .BAS que contiene declaraciones de constante genéricas del proyecto Visual Basic.

Nota: La ventana de proyecto intrínsecamente describe la lista de archivos en un proyecto, por lo que esta sección de información general sólo se necesita proporcionar información sobre los módulos y los archivos más importantes o los archivos que no mostrar la ventana proyecto, como archivos de base de datos o de inicialización (ini).

El código de formato

Dado que muchos programadores utilizan todavía muestra VGA, inmobiliaria de pantalla debe se ahorra tanto como sea posible pero permitiendo formato para reflejar la estructura lógica y el anidamiento de código.

Bloque estándar, basada en ficha, las sangrías de anidamiento debe ser dos a cuatro espacios. Más de cuatro espacios innecesarios y puede hacer que las instrucciones que se oculta o trunca accidentalmente. Menos de dos espacios no muestra suficientemente anidamiento lógica. En Microsoft Knowledge Base, utilizamos una sangría de espacio de tres. Utilice el cuadro de diálogo Opciones de entorno para establecer el ancho de la ficha predeterminado.

El comentario de introducción funcional de una rutina debe ser un espacio de sangría. Las instrucciones de nivel más altos que siga el comentario de introducción deben ser una ficha con sangría, con cada bloque anidado aplica sangría a una ficha adicional. Por ejemplo: variables y constantes no genéricas deben estar agrupadas por función en lugar de por va a dividir desactivar áreas aisladas o archivos especiales. Constantes genéricos de Visual Basic como el reloj de ARENA deben agruparse en un solo módulo (VB_STD.BAS) para mantenerlos independiente de las declaraciones de específicos de la aplicación.

Operadores

Siempre utilice una y comercial (&) al concatenar cadenas y el signo más (+) cuando se trabaja con valores numéricos. Con un signo más (+) con valores no numéricos, puede causar problemas cuando funciona en las dos variantes. Por ejemplo:

Ámbito

Siempre se deben definir las variables con el ámbito más pequeño posible. Variables globales pueden cree máquinas de estado enormemente complejos y realice la lógica de una aplicación extremadamente difíciles de entender. Variables globales también que la reutilización y mantenimiento de su código mucho más difícil. Variables en Visual Basic pueden tener el siguiente ámbito: en una aplicación de Visual Basic, sólo utilizar variables globales cuando no hay ninguna manera otro conveniente compartir datos entre formularios. Puede que desee almacenar información en propiedad de etiqueta del control, lo que puede tener acceso global mediante la sintaxis form.object.property.

Si debe utilizar variables globales, es conveniente declarar todas ellas en un solo módulo y agruparlos por función. Asignar el módulo de un nombre significativo que indique su propósito, como GLOBAL.BAS.

Con la excepción de variables (que no deben pasarse), procedimientos y funciones globales sólo deben trabajar con objetos que se pasan a ellos. Variables globales que se utilizan en las rutinas deben identificarse en el área comentario general en el principio de la rutina. Además, pasar argumentos a subrutinas y funciones mediante ByVal, a menos que explícitamente desee cambiar el valor del argumento pasado.

Escribir código modular siempre que sea posible. Por ejemplo, si la aplicación muestra un cuadro de diálogo, colocar todos los controles y código necesario para realizar tareas del cuadro de diálogo en un solo formulario. Esto ayuda a mantener el código de la aplicación organizado en componentes útiles y reduce su sobrecarga de tiempo de ejecución.

Controles de terceros

Nota: Los productos que se describen a continuación están fabricados por proveedores independientes de Microsoft. Microsoft no otorga ninguna garantía, implícita o de otro tipo, con respecto al rendimiento o confiabilidad de estos productos.

La tabla siguiente muestra caracteres de prefijo nombre de proveedor estándar de terceros para utilizarse con los prefijos de control: la tabla siguiente muestra los prefijos de control de terceros estándar: