-
Notifications
You must be signed in to change notification settings - Fork 9
Conventions de nommage
- Elodie
- Anabelle
Récapitulatif language et coding style:
C/C++, Java,PHP, JavaScript, typeScript ==> >CamelCase langages de script (Ruby, Python) ==> snake_case
Exemple avec des recettes , ici avec l'objet recipe
| Types d'attributs | Exemple |
|---|---|
| Objet | recipe (au singulier) |
| Tableau d'objets | recipes (au pluriel) |
| Observables | recipe$ |
| Subscription | recipesSub |
| Attribut id | _id |
| Clé étrangère d'un autre objet | recipe_id |
➡️ Dans un objet on a toujours un attribut _id dans la classe côté client correspondant à l’_id du JSON côté serveur (même écriture)
➡️ On peut parfois avoir besoin de créer une clé étrangère. C'est à dire utiliser, faire une référence à l'id d'une autre table. Dans ce cas, on utilise « id_ ». Ex: Nos recettes sont créées par des membres (objet "member" et id_recipe est l'attribut qui permettra de faire le lien.
Trouver des noms qui ne portent jamais à confusion (bon courage !).
Ex avec l'attribut paid: Est-ce qu'il s'agit d'un attribut qui indique que le paiement est payé ou alors de la date à laquelle il a été payé ?
solution à ce problème :
payment = payplug.getPayment(id='pay_CD9SCD')payment.is_paid => C'est payé, pas de doute on le sait tout de suite.
On utilise des noms intuitifs comme on a l'habitude de voir sur les exos des profs: getRecipe(), setRecipe(), addRecipe(), removeRecipe(), etc.