UiPath Documentation
studio
2024.10
false
Guia do usuário do Studio
Importante :
A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

STN MG-002 - Convenção de nomenclatura de argumentos

Regra ST-NMG-002 (categoria NMG) no Studio: impõe uma convenção de nomenclatura para argumentos em todos os fluxos de trabalho no projeto.

ID de regra: ST-NMG-002

Escopo: fluxo de trabalho

Description​

Essa regra analisa todos os argumentos no projeto e determina se eles seguem a convenção específica.

Os argumentos do projeto devem seguir uma convenção de nomenclatura específica para facilitar a compreensão do projeto e para mantê-lo. O nome do argumento deve ser significativo e incluir uma indicação do seu tipo:

  • In – O argumento só pode ser usado dentro de um determinado projeto.
  • Out – O argumento pode ser utilizado para passar dados fora de um determinado projeto.
  • IO – O argumento pode ser usado dentro e fora de um determinado projeto.

Recomendação​

Certifique-se de que todos os argumentos seguem a convenção de nomenclatura. A expressão Regex padrão para essa regra é:

  • 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 acordo com a expressão regex acima, o argumento corresponde à expressão se ele começar com um prefixo, seguido por uma letra minúscula ou maiúscula, e um número.

Por exemplo, se o nome do argumento no fluxo de trabalho for in_HelloWorld, ele será validado pela regra. Outros exemplos de nomes de argumentos que seguem essa regra regex são: out_HelloWorld e io_Helloworld.

Modificando a regra​

Na janela Configurações do Projeto, selecione a guia Analisador de Fluxo de Trabalho. Localize e selecione a regra, 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 para os argumentos In, o padrão de pesquisa será ^in_(dt_)?([a-z])+([0-9])*$. Agora a regra verifica se os argumentos iniciam com uma letra minúscula após o prefixo.

Se adicionarmos [a-z]|[A-Z]), a regra será ^in_(dt_)?([A-Z]|[a-z]|[a-z]|[A-Z])+([0-9])*$, e reconhecerá in_HelloWonderfulWorld como um nome de argumento 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 do argumento começa com uma letra maiúscula, sem espaços ou pontuação.

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

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

Pascal Case​

A convenção Pascal Case especifica que o nome do argumento deve conter palavras com letras maiúsculas concatenadas.

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

Nomes válidos: in_Hello1World2, in_HelloWorld, in_Hello1World.

Kebab Case​

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

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

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

Redefinir os valores padrão​

Os valores padrão para o Regex da ST-NMG-002 são:

  • 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 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.

  • Description​
  • Recomendação​
  • Modificando a regra​
  • Exemplos de expressões Regex​
  • Camel Case​
  • Pascal Case​
  • Kebab Case​
  • Redefinir os valores padrão​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte(opens in new window)

Quer aprender? Academia UiPath(opens in new window)

Tem perguntas? Fórum do UiPath(opens in new window)

Fique por dentro das novidades