ST-NMG-001: convención sobre nombres de variables

ID de la regla:ST-NMG-001

Ámbito: actividad

Descripción

Las variables de un proyecto deberán seguir una convención de nombres específicos para facilitar la comprensión del propósito de la variable y su mantenimiento. El nombre de la variable debe ser significativo para describir con precisión su uso durante todo el proyecto.

Esta regla analiza todas las variables del proyecto y determina si siguen la convención específica. Si no es así, se registra un mensaje en el panel de la Lista de errores.

Recomendable

Asegúrate de que todas las variables sigan la convención de nombres. La regla comprueba que los nombres de las variables se ajustan a esta expresión Regex por defecto ^([A-Z]|[a-z])+([0-9])*$.

De acuerdo con la expresión Regex anterior, el nombre de la variable cumple la regla si comienza con una letra minúscula o mayúscula, seguida de una letra minúscula o mayúscula y luego uno o más números.

Por ejemplo, si el nombre de la variable en el flujo de trabajo es HelloWorld1, entonces coincide con la expresión Regex por defecto establecida en esta regla.

Modificar la regla

En la ventana Configuración del proyecto, selecciona la pestaña Analizador de flujo de trabajo. Busca y selecciona la regla, como se muestra en la siguiente imagen:

En la sección Regex, agrega o elimina caracteres del patrón de búsqueda. Por ejemplo, si eliminamos la parte [A-Z] de la expresión, el patrón de búsqueda se convierte en ^([a-z])+([0-9])*$. Ahora la regla comprueba si las variables empiezan con una letra minúscula y van seguidas de un número.

Si agregamos [a-z]|[A-Z]), entonces la regla se convierte en ^([A-Z]|[a-z]+[a-z]|[A-Z])+([0-9])*$, y reconoce HelloWonderfulWorld como nombre de variable válida.

Ejemplos de expresiones Regex

La expresión regex por defecto para esta regla puede ser cambiada por otra convención de nombres. Comprueba la lista siguiente:

Caso de Camel

La convención de caso de Camel especifica que cada palabra en medio del nombre de la variable comienza con una letra mayúscula, sin espacios intermedios ni puntuación.

Ejemplo de expresión Regex: ([A-Z]|[a-z])+([A-Z]|[a-z]|[0-9]).

Nombres de variables válidos: Hello1World2, helloWorld, Hello1World.

Caso de Pascal

La convención de nombres de caso de Pascal especifica que el nombre de la variable debe contener palabras mayúsculas concatenadas.

Ejemplo de expresión Regex: ([A-Z])+([A-Z]|[a-z]|[0-9]).

Nombres válidos: Hello1World2, HelloWorld, Hello1World.

Caso de Kebab

La convención de nombres del caso de Kebab se asemeja al caso Snake, salvo que sustituye los espacios por guiones en lugar de guiones bajos.

Ejemplo de expresión Regex: ([a-z]|[A-Z])([\w-]+)+([a-z]|[A-Z]|[0-9])

Nombres válidos: Hello1‐World2, Hello‐World.

Restablecer a valores por defecto

El valor por defecto para el ST-NMG-001 Regex es ^([A-Z]|[a-z])+([0-9])*$.

Algunas reglas del Analizador de flujo de trabajo tienen valores por defecto. Para restablecer estos valores por defecto, haz clic con el botón derecho del ratón en una regla de la ventana Configuración del proyecto y luego haz clic en Restablecer valores por defecto.