Vous êtes-vous déjà demandé pourquoi certaines bases de code PHP sont un plaisir de travailler avec alors que d'autres ressemblent à un labyrinthe ? Cela se résume en grande partie au respect de normes de codage cohérentes. Explorons PSR-1, la base du développement PHP moderne qui aide les équipes à écrire du code plus propre et plus maintenable !
Aperçu des règles PSR-1
1. Fichiers et espaces de noms
- Les fichiers DOIVENT utiliser uniquement les balises
- Les fichiers DOIVENT utiliser uniquement UTF-8 sans BOM pour le code PHP
- Les fichiers DEVRAIENT soit déclarer des symboles (classes, fonctions, constantes) OU provoquer des effets secondaires (générer une sortie, modifier les paramètres, etc.) mais NE DEVRAIENT PAS faire les deux
2. Espace de noms et noms de classe
- Les cours DOIVENT être déclarés dans StudlyCaps
- Les constantes de classe DOIVENT être déclarées en majuscules avec des séparateurs de soulignement
3. Méthodes de classe
- Les noms de méthodes DOIVENT être déclarés dans camelCase
Mise en œuvre pratique
Regardons une implémentation PSR-1 correcte à partir de notre exemple de référentiel :
$id, 'name' => 'John Doe'];
}
}
Cet exemple démontre :
- Déclaration d'espace de noms appropriée à l'aide de StudlyCaps
- Nom de la classe dans StudlyCaps
- Constantes en majuscules avec traits de soulignement
- Nom de la méthode dans camelCase
Violations et correctifs courants
Responsabilités Mixtes
Nom incorrect
Intégration avec les outils PHP modernes
Notre exemple de référentiel inclut la configuration pour :
- PHP_CodeSniffer pour la validation PSR-1 (style de vérification du compositeur)
- Fixation automatique du style (style de correction du compositeur)
- PHPUnit pour tester les implémentations
- Chargement automatique du compositeur suite au PSR-4
Prochaines étapes
Dans notre prochain article, nous explorerons le PSR-12, qui étend ces normes de codage de base avec des directives de style plus complètes. Cet article fait partie de notre série Normes PSR en PHP.
Ressources
- Spécification officielle PSR-1
- Ensemble de règles PHP_CodeSniffer PSR-1
-
Référentiel d'exemples de séries (v0.1.0 - Implémentation PSR-1)
Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!