STN MG-001 - Convenção de nomenclatura de variáveis

ID de regra: ST-NMG-001

Escopo: Atividade

Description

As variáveis de um projeto devem seguir uma convenção de nomenclatura específica para facilitar a compreensão da finalidade da variável e para mantê-la. O nome da variável deve ser significativo para descrever seu uso com precisão durante o projeto.

Essa regra analisa todas as variáveis do projeto e determina se elas seguem a convenção específica. Caso contrário, uma mensagem será registrada em log no painel Lista de Erros.

Recomendação

Certifique-se de que todas as variáveis seguem a convenção de nomenclatura. A regra verifica se os nomes das variáveis obedecem a essa expressão Regex padrão ^([A-Z]|[a-z])+([0-9])*$.

De acordo com a expressão Regex acima, o nome da variável obedece à regra quando começar com uma letra minúscula ou maiúscula, seguido por uma letra minúscula ou maiúscula, e depois um ou mais números.

Por exemplo, se o nome da variável no fluxo de trabalho for HelloWorld1, ele corresponde à expressão Regex padrão definida nesta regra.

Modificando a regra

Na janela Configurações do Projeto, selecione a guia Analisador de Fluxo de Trabalho. Encontre a regra e selecione-a, conforme a imagem abaixo:

Na seção Regex, adicione ou remova caracteres do padrão de pesquisa. Por exemplo, se removermos a parte [A-Z] da expressão, o padrão de pesquisa será ^([a-z])+([0-9])*$. Agora a regra verifica se as variáveis começam com uma letra minúscula e se são seguidas por um número.

Se adicionarmos [a-z]|[A-Z]), a regra se tornará ^([A-Z]|[a-z]+[a-z]|[A-Z])+([0-9])*$ e reconhecerá HelloWonderfulWorld como um nome de variável válido.

Exemplos de expressões Regex

A expressão regex padrão para essa regra pode ser alterada para outra convenção de nomenclatura. Verifique a lista abaixo:

Camel Case

A convenção Camel Case especifica que cada palavra no meio do nome da variável começa por uma letra maiúscula, sem espaços ou pontuação.

Exemplo de expressão Regex: ([A-Z]|[a-z])+([A-Z]|[a-z]|[0-9]).

Nomes válidos de variáveis: Hello1World2, helloWorld, Hello1World.

Pascal Case

A convenção Pascal Case especifica que o nome da variável deve conter palavras com letras maiúsculas concatenadas.

Exemplo de expressão Regex: ([A-Z])+([A-Z]|[a-z]|[0-9]).

Nomes válidos: Hello1World2, HelloWorld, Hello1World.

Kebab Case

A convenção Kebab Case é semelhante à Snake Case, exceto que ela substitui os espaços por hifens ao invés de sublinhados.

Exemplo de expressão Regex: ([a-z]|[A-Z])([\w-]+)+([a-z]|[A-Z]|[0-9]).

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

Redefinir os valores padrão

O valor padrão do Regex da ST-NMG-001 é ^([A-Z]|[a-z])+([0-9])*$.

Algumas regras do Analisador de Fluxo de Trabalho têm valores padrão. Para redefinir esses valores para os padrões, clique com o botão direito em uma regra na janela Configurações do Projeto e clique em Redefinir para o padrão.