Conventions de nommage

Par Etienne Gaudry

Publié dans DevOps

06 juillet, 2022

1 min de lecture

Table des matières

🗂️ Objets et champs personnalisés

✔️ Règle de validation

✉️ Alertes par e-mail

👌 Processus d'approbation

🤞 Étapes de processus d'approbation

📄 Classes Apex et Pages Visualforce

👨‍💻 Déclencheurs Apex

👩🏽‍💻 Méthodes Apex

🧑🏿‍💻 Variables Apex

Comment faciliter la lecture et la maintenance de votre application ? 🤔

Les conventions de nommage sont importantes dans Salesforce car elles permettent d’améliorer la lisibilité, d’éviter les erreurs et de favoriser le travail en équipe. Gardez en tête que les noms utilisés doivent être descriptifs, concrets et spécifiques plutôt que généraux. Les acronymes et abréviations seront évités, hormis ceux largement utilisés et communément compris (HTTP, URL, etc).

🗂️ Objets et champs personnalisés

Conventions

<ObjectName>__c
<FieldName>__c

Nom API au singulier, en anglais et fidèle à l’étiquette (label)
PascalCase : première lettre de chaque mot en majuscule
Aucun traits de soulignement ”_” hormis “__c”

Exemples

	Nom	Explication
❌	CustAsset__c	Abréviation
✅	CustomerAsset__c	Améliore la lisibilité et la maintenabilité
	----------	----------
❌	Orders__c	Pluriel
✅	Order__c	Assure une dénomination standard pour tous
	----------	----------
❌	Order_Item__c	Trait de soulignement
✅	OrderItem__c	Évite la confusion (les mots que certains séparent et d’autres non, par exemple Zipcode et Zip Code)

✔️ Règle de validation

Conventions

<FieldName> <Rule>

Exemples

	Nom	Explication
❌	Validate Address	Utilisation superflue du mot valider
✅	StreetAddress < 60 chars	Champ et règle clairement identifiés

✉️ Alertes par e-mail

Conventions

<Description du destinataire> - <Modèle de mail utilisé>

Exemples

	Nom	Explication
❌	Informer l’équipe du changement	On ne sait pas quel e-mail sera envoyé
✅	Envoyer un e-mail à l’équipe client décédé - Nouveau client décédé	Décrit à qui est envoyé l’e-mail et quel modèle est utilisé

👌 Processus d’approbation

Conventions

<Événement qui a déclenché l'approbation>

Ne pas nommer les actions (elles peuvent changer au fil du temps)
Ne pas nommer l’objet (il existe un champ standard dans la vue de liste qui peut l’afficher et le filtrer)

Exemples

	Nom	Explication
❌	Envoyer un e-mail en cas de rejet	Les actions effectuées ne doivent pas être utilisées dans le nom
✅	Opportunité gagnée	Une brève description des critères d’entrée indique une intention claire du moment où le processus sera utilisé

🤞 Étapes de processus d’approbation

Conventions

<Résultat de la décision> - <Description>

Exemples

	Nom	Explication
❌	Approbation complexe - Étape 1	Ne fournit pas aux utilisateurs une image suffisamment claire de ce qui a été évalué
✅	Refus automatique - La valeur dépasse la politique de l’entreprise	L’étape d’approbation devient auto-documentée montrant à l’administrateur et à l’utilisateur le résultat de l’étape d’approbation

📄 Classes Apex et Pages Visualforce

Conventions

// Apex Class
<ClassName>
// Visualforce Page
<PageName>
// Visualforce Controller
<ClassName>Controller
// Visualforce Extension
<StandardControllerName><ClassName>Ext
// TriggerHandler
<ClassName>TriggerHandler
// Service Class
<ClassName>Service
// Wrapper
<WrapperName>Wrapper
// Web Service (SOAP)
<ClassName>Ws
// Web Service (REST)
<ClassName>Rest
// Asynchronous (Future)
<ClassName>Async
// Asynchronous (Batch)
<ClassName>Batch
//Queuable Apex
<ClassName>Queue
// Scheduled Apex
<ClassName>Job
// Test Class
<ClassName>Test
// Test Data Factory
<ClassName>TestDataFactory

PascalCase (première lettre de chaque mot en majuscule)
En anglais
Aucun traits de soulignement ”_”

Exemples

	Nom	Explication
❌	Override_Customer_View	Trait de soulignement
✅	CustomerView	Nom clair et succinct
	----------	----------
❌	GrtBgClass	Abréviation
✅	GreatBigClass	Améliore la lisibilité et la maintenabilité