ST-NMG-002: convención de nombres de argumentos

ID de la regla:ST-NMG-002

Ámbito: flujo de trabajo

Descripción

Esta regla analiza todos los argumentos del proyecto y determina si siguen la convención específica.

Para facilitar la comprensión del proyecto y su mantenimiento, los argumentos del proyecto deben seguir una convención de nombres específica. El nombre de los argumento debe ser significativo e incluir una indicación de su tipo:

• en: el argumento solo puede ser usado dentro del proyecto dado.
• fuera: el argumento puede usarse para pasar datos fuera de un proyecto determinado.
• io: el argumento puede usarse tanto dentro como fuera de un proyecto dado.

Recomendable

Asegúrate de que todos los argumentos siguen la convención de nombres. La expresión Regex por defecto para esta regla es:

• InRegex: ^in_(dt_)?([A-Z]|[a-z])+([0-9])*$
• OutRegex: ^out_(dt_)?([A-Z]|[a-z])+([0-9])*$
• InOutRegex: ^io_(dt_)?([A-Z]|[a-z])+([0-9])*$.

De acuerdo con la expresión regex anterior, el argumento coincide con la expresión si comienza con un prefijo, seguido de una letra minúscula o mayúscula, y un número.

Por ejemplo, si el nombre del argumento en el flujo de trabajo es in_HelloWorld, entonces es validado por la regla. Otros ejemplos de nombres de argumentos que siguen esta regla regex son: out_HelloWorld y io_Helloworld.

Modificar la regla

En la ventana Configuración del proyecto, selecciona la pestaña Analizador del flujo de trabajo. Busca y selecciona la regla, como se ve 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 para los argumentos En, el patrón de búsqueda se convierte en ^in_(dt_)?([a-z])+([0-9])*$. Por lo tanto, la regla comprueba si los argumentos En comienzan con una letra minúscula después del prefijo.

Si agregamos [a-z]|[A-Z]), en ese caso la regla se convierte en ^in_(dt_)?([A-Z]|[a-z]|[a-z]|[A-Z])+([0-9])*$, y reconoce in_HelloWonderfulWorld como un nombre válido del argumento In.

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 las mayúsculas especifica que cada palabra en medio del nombre del argumento comienza con una letra mayúscula, sin espacios intermedios ni puntuación.

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

Nombres de argumentos válidos: in_Hello1World2, in_helloWorld, in_Hello1World.

Caso de Pascal

La convención de denominación de casos de Pascal especifica que el nombre del argumento debe contener palabras mayúsculas concatenadas.

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

Nombres válidos: in_Hello1World2, in_HelloWorld, in_Hello1World.

Caso de Kebab

La convención de denominación del caso de Kebab es similar al de snake, con la diferencia de que sustituye los espacios por guiones en lugar de guiones bajos.

Ejemplo de la expresión Regex: ^in_(dt_)?([a-z]|[A-Z]|[0-9])+‐([a-z]|[A-Z]|[0-9])

Nombres válidos: in_Hello1‐World2, in_Hello‐World.

Restablecer a valores por defecto

Los valores predeterminados para ST-NMG-002 Regex son:

• InRegex: ^in_(dt_)?([A-Z]|[a-z])+([0-9])*$
• OutRegex: ^out_(dt_)?([A-Z]|[a-z])+([0-9])*$
• InOutRegex: ^io_(dt_)?([A-Z]|[a-z])+([0-9])*$.

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.