normalisation du code
En SelfishNous comprenons l'importance cruciale du respect de normes élevées en matière de rédaction et de structuration du code. Cette page est consacrée à nos directives de standardisation du code, un ensemble de règles et de pratiques que nous suivons rigoureusement afin de garantir la qualité, l'efficacité et la maintenabilité de nos projets de développement web.
Vous trouverez ici un guide détaillé de nos méthodes et principes de normalisation du code, conçus non seulement pour améliorer la cohérence et la prévisibilité de notre travail, mais aussi pour faciliter la collaboration et la compréhension entre les membres de notre équipe et nos clients.
Ces recommandations sont le fruit de plusieurs années d'expérience et d'apprentissage continu. Elles reflètent les meilleures pratiques du secteur et s'adaptent aux dernières tendances et technologies en matière de développement logiciel. Que vous soyez membre de notre équipe, contributeur ou simplement intéressé par les bonnes pratiques de programmation, nous sommes convaincus que vous trouverez ces informations précieuses et enrichissantes.
Code lisible et propre.
Évitez de mélanger le code contenant des fonctions similaires.
Tabulation à 4 espaces.
CRLF uniquement vers LF.
Utilisation appropriée des espaces.
Paramètres de sortie au début.
Code anglais.
Bien que la page puisse être en plusieurs langues, il serait, par souci de conformité aux pratiques courantes, que notre programmation soit réalisée en anglais.
Variables auto-descriptives.
Une variable doit être compréhensible par son nom, tout en veillant à ce qu'il soit aussi bref que possible.
Diviser pour mieux régner
Exécuter des fonctions et du code atomique pour les tâches répétitives.
L'implémentation de fonctions permet de minimiser la quantité de code répétitif dans le programme et de granulariser les fonctions pour faciliter la maintenance.
Opérateurs ternaires lorsque cela est approprié
Encouragez l'utilisation correcte des opérateurs ternaires lorsqu'ils n'affectent pas la lisibilité du code.
Notation
Par convention et par préférence de l'utilisateur, la notation utilisée sera « Snake Case ».
À l'exception de la gestion des classes, qui dépend du langage de programmation utilisé et où, dans la plupart des cas, les classes sont nommées en CamelCase, les noms de classes sont généralement utilisés.
Les booléens avec le préfixe (est)
Conformément à la logique et aux normes de la programmation en anglais, la marche à suivre consiste à utiliser le préfixe « is » lors de la déclaration d'une variable booléenne ou lors de la création d'une fonction dont le but est de renvoyer une réponse similaire.
Documentation et séparation du code appropriées
Il sera nécessaire de fournir des commentaires de base sur le fonctionnement du code, ainsi que des indications pour décrire les variables et localiser facilement la partie du code concernée.
Comparaison explicite
Pour prévenir les erreurs, la méthode appropriée consiste à utiliser des comparaisons explicites au sein des structures de contrôle.
Validation des chaînes vides
En matière de prévention des risques, la meilleure solution consiste à utiliser les outils que le langage peut nous fournir.
Évitez les variables inutiles
En PHP comme en Javascript, le code peut être rendu plus efficace en évitant la création de variables inutiles.
Évitez d'utiliser plusieurs requêtes et accès au DOM.
En complément du point précédent, lorsqu'il est nécessaire d'effectuer plusieurs requêtes dans n'importe quel langage, la bonne pratique consiste à n'effectuer la requête qu'une seule fois et à utiliser une variable.
Gestion des exceptions
L'utilisation correcte des exceptions permet une gestion des erreurs qui ne compromet pas le bon fonctionnement du code.
Utilisation de jQuery.
Par convention, il sera recommandé d'utiliser jQuery comme méthode d'accès au DOM lorsque cela sera nécessaire.
Évitez les requêtes de base de données.
Par convention, il sera recommandé d'utiliser jQuery comme méthode d'accès au DOM lorsque cela sera nécessaire.
Évitez les requêtes de base de données.
WordPress offre un grand nombre de fonctions d'interrogation de données ; il convient donc d'éviter autant que possible les requêtes directes à la base de données.
Évitez les composants dépendants de tiers.
Pour éviter les dépendances vis-à-vis de fonctions tierces, la meilleure approche consiste, dans la mesure du possible, à récupérer le code à utiliser et à l'ajouter à WordPress.
Méthode KISS.
KISS est l'acronyme de « Keep It Simply Stupid » (Faites simple, c'est stupide). Un code simple et facile à comprendre est beaucoup plus facile à maintenir sur le long terme ; il est donc parfois judicieux de sacrifier un peu de performance pour garantir que le code respecte ce principe.
Utilisez un EDI standard.
En raison d'obligations contractuelles, le même environnement de développement intégré (IDE) sera utilisé pour les projets hors WordPress. Il s'agira de VS Code.
Mettre en place un logiciel de contrôle de version.
Git sera utilisé comme logiciel de contrôle de version.