Conventions de désignation des paramètres et des contraintes
Lorsque vous créez des paramètres et des éléments logiques de contrainte, il est recommandé d'établir une convention de désignation pour faciliter l'utilisation des structures de module configurable. Une convention de désignation est utile lorsque plusieurs utilisateurs travaillent avec ces fonctionnalités, ou que vous prévoyez de conserver une structure de module configurable sur une longue période.
Prenons les exemples suivants :
Elément logique
Utilisation
Convention de désignation
Exemples
Paramètre d'entrée
Obtient des informations auprès de l'utilisateur.
Accolez au nom approprié le préfixe ask.
askName
askOption
Paramètre booléen
Est appliqué au lien de cas d'emploi entre un module configurable et un article enfant pour activer ou désactiver le cas d'emploi de l'article enfant. Dans le Navigateur de structure d'article, le lien de cas d'emploi correspond au champ Option d'inclusion affiché dans l'onglet Composants.
Accolez au nom approprié le préfixe use.
useOption1
useOption2
Contrainte de tableau de cas
Sélectionne une valeur ou un ensemble de valeurs en fonction d'un jeu d'entrées.
Accolez au nom approprié le préfixe pick.
pickColor
pickSize
Contrainte
Définit un paramètre sur une valeur spécifique en fonction d'une ou de plusieurs conditions.
Accolez au nom approprié le préfixe set.
setColor
setName
Contrainte de référence
Etablit une référence entre deux paramètres, entraînant ainsi l'utilisation de la valeur d'un paramètre pour un autre paramètre.
Accolez au nom approprié le préfixe ref.
refSize
refWeight
Est-ce que cela a été utile ?