Conventions de nommage

• Utilisez des noms descriptifs et significatifs pour vos variables afin de clarifier leur but et leur contenu.
• En anglais
• Utilisez le style camelCase pour les variables (avec la première lettre en minuscule), par exemple : $username, $emailAdress, etc.
• Évitez les noms de variables trop courts ou ambigus, préférez la clarté à la brièveté.

• Utilisez des verbes d'action pour nommer vos fonctions afin de décrire ce qu'elles font.
• En anglais
• Utilisez également le style camelCase pour les noms de fonctions.
• Exemple : moveToLeft(), addNewFile(), etc.
• Si une fonction retourne une valeur booléenne, il est courant de commencer le nom par "is", "has", ou "can", par exemple : isValid():bool, hasEmail():bool, canAddNumber():bool etc.
• A titre personnel : J'utilise le PascalCase pour ceci en particulier, qui est la convention Microsoft.

• Utilisez le style PascalCase pour les noms de classes (avec la première lettre de chaque mot en majuscule), par exemple : User, Aricle, etc.
• En anglais
• Choisissez des noms de classes descriptifs qui reflètent leur rôle dans l'application.
• Évitez les acronymes ou les abréviations non explicites dans les noms de classes, préférez la clarté à la brièveté.

• Utilisez des majuscules avec des traits de soulignement pour les noms de constantes, par exemple : VAT, ROOT, etc.
• En anglais
• Les constantes doivent être toutes en majuscules pour les distinguer des variables.

• Choisissez des noms de fichiers descriptifs et significatifs qui reflètent leur contenu.
• En anglais
• Utilisez le style snake_case pour les noms de fichiers, en utilisant des traits de soulignement pour séparer les mots, par exemple : fonctions_utilitaires.php, classe_utilisateur.php, etc.
• A titre personnel, je vais plus souvent utiliser le PascalCase pour coller avec le nom des classes pour les fichiers de programmation, et le camelCase pour les fichiers front-end, mais c'est aussi une habitude Microsoft, le snake_case est compréhensible et souvent utilisé dans le web, sachez ici que le KebabCase est aussi souvent utilisé, exemple package-lock.json

• Choisissez des noms de dossiers descriptifs et significatifs qui reflètent leur contenu.
• En anglais
• Utilisez le style sake_case pour les noms de dossier, chaque mot doit commencer par une majuscule, par exemple : /node_modules, /resources, etc.
• A titre personnel, je vais plus souvent utiliser le PascalCase sauf cas particulier

• Utilisez des commentaires pour expliquer le but et le fonctionnement des éléments de votre code lorsque cela n'est pas immédiatement évident.
• Écrivez des commentaires clairs et concis en utilisant un langage simple et compréhensible par tous les membres de l'équipe de développement.

En suivant des conventions de nommage cohérentes et bien établies, vous pouvez rendre votre code plus lisible, compréhensible et maintenable. Cela facilite également la collaboration avec d'autres développeurs et contribue à une meilleure organisation de votre projet.
De mon côté, comme vous avez pu le voir, j'utilise une convention de nommage personnel, et vous aussi, vous pourriez vous faire la vôtre ! L'important c'est de respecter celle qui est en place dans le projet d'un autre, et de respecter la votre dans votre projet. A titre personnel, j'aime appliquer celle que j'ai mis au point, car ça me permet aussi du premier coup d'oeil de repérer quelque chose que j'ai créé de quelque chose d'implémenté de base dans le programme. Je sais par exemple que mail() est une fonction native à PHP, alors que GoToLeft() est une fonction que j'ai créé.

#cours #blindcode #php #backend #fullstack #formulaire #bonnes #pratiques

créé le 2024-03-13 à 08:04