ST-NMG-001 - Convention d'affectation de noms des variables

ID de règle : ST-NMG-001

Étendue : activité

Description

Les variables d'un projet doivent respecter une convention d'affectation de noms spécifique afin de faciliter la compréhension de la fonction de la variable et de la gérer. Le nom de la variable doit être significatif pour décrire avec précision son utilisation durant le projet.

Cette règle analyse toutes les variables du projet et détermine si elles respectent la convention spécifique. Sinon, un message est consigné dans le panneau Liste d'erreurs (Error List).

Recommandation

Assurez-vous que toutes les variables suivent la convention d'affectation de noms. La règle vérifie que les noms de variables respectent cette expression Regex ^([A-Z]|[a-z])+([0-9])*$ par défaut.

Selon l'expression Regex ci-dessus, le nom de la variable respecte la règle s'il commence par une minuscule ou une majuscule, suivie d'une minuscule ou une majuscule, puis d'un ou de plusieurs chiffres.

Par exemple, si le nom de la variable dans le workflow est HelloWorld1, il correspond à l'expression Regex par défaut définie dans cette règle.

Modification de la règle

Dans la fenêtre Paramètres du projet (Project Settings), sélectionnez l'onglet Analyseur de workflow (Workflow Analyzer). Recherchez et sélectionnez la règle, comme sur l'image ci-dessous :

Dans la section Regex (Regex), ajoutez ou supprimez des caractères du modèle de recherche. Par exemple, si nous supprimons la partie [A-Z] de l'expression, le modèle de recherche devient ^([a-z])+([0-9])*$. La règle vérifie maintenant si les variables commencent par une lettre minuscule et sont suivies d’un nombre.

Si nous ajoutons [a-z]|[A-Z]), la règle devient ^([A-Z]|[a-z]+[a-z]|[A-Z])+([0-9])*$ et reconnaît HelloWonderfulWorld en tant que nom de variable valide.

Exemples d'expressions Regex

L'expression Regex par défaut pour cette règle peut être remplacée par une autre convention d'affectation de noms. Consultez la liste ci-dessous :

Casse mixte

La convention de case mixte spécifie que chaque mot au milieu du nom de la variable commence par une majuscule, sans espace ni ponctuation entre.

Exemple d'expression Regex : ([A-Z]|[a-z])+([A-Z]|[a-z]|[0-9]).

Noms de variables valides : Hello1World2, helloWorld, Hello1World.

Casse Pascal

La convention d'affectation de la casse Pascal spécifie que le nom de la variable doit contenir des mots en majuscules concaténés.

Exemple d'expression Regex : ([A-Z])+([A-Z]|[a-z]|[0-9]).

Noms valides : Hello1World2, HelloWorld, Hello1World.

Casse Kebab

La convention d'affectation de noms de la casse Kebab est similaire à celle de la casse Snake, sauf qu'elle remplace les espaces par des traits d'union plutôt que des traits de soulignement.

Exemple d'expression Regex : ([a-z]|[A-Z])([\w-]+)+([a-z]|[A-Z]|[0-9])

Noms valides : Hello1‐World2, Hello‐World.

Rétablir les valeurs par défaut

La valeur par défaut pour l'expression régulière ST-NMG-001 est ^([A-Z]|[a-z])+([0-9])*$.

Certaines règles de l'analyseur de workflow (Workflow Analyzer) ont des valeurs par défaut. Pour réinitialiser ces valeurs par défaut, cliquez avec le bouton droit sur une règle dans la fenêtre Paramètres du projet (Project Settings), puis cliquez sur Rétablir les paramètres par défaut (Reset to default).