Maison  >  Article  >  développement back-end  >  Une introduction détaillée à plusieurs points sur les règles de dénomination PHP

Une introduction détaillée à plusieurs points sur les règles de dénomination PHP

黄舟
黄舟original
2017-07-26 13:13:151353parcourir

Lors de l'écriture de code, une bonne norme de codage peut avoir de nombreux effets inattendus pour nous. Par exemple :

1. Améliorer notre efficacité de codage. Le code soigné et uniforme nous permet de copier et coller facilement !

2. Améliorer la lisibilité du code.

3. Montrer que nous sommes professionnels. D'autres ont vu notre code et ont trouvé que l'ensemble du processus d'écriture du code était soigné et uniforme, et ils ont immédiatement été impressionnés !

4. Faciliter la collaboration en équipe. Tout le monde utilise le même standard, ce qui élimine les différentes méthodes d’écriture et assure une coordination unifiée !

Une introduction détaillée à plusieurs points sur les règles de dénomination PHP

Développer une bonne habitude d'écrire du code de manière standardisée

Voyons donc quelles sont les spécifications ?

Fichiers et lignes

  • Les fichiers de code PHP doivent commencer par

  • le code doit utiliser 4 espaces au lieu de la touche de tabulation pour l'indentation ;

  • Les fichiers de code PHP doivent être encodés en UTF-8 sans BOM

  • Code PHP pur Le fichier ; doit omettre la balise de fermeture finale ?>

  • Tous les fichiers PHP doivent se terminer par une ligne vide

  • Tous les fichiers PHP doivent utiliser Unix ; LF (saut de ligne) comme terminateur de ligne ;

  • Le code PHP dans les fichiers de vue (sauf le code du modèle) doit utiliser la balise longue étiquette de sortie ; d’autres étiquettes personnalisées ne doivent pas être utilisées.

  • Il ne doit y avoir aucun espace supplémentaire après les lignes non vides

  • Le nombre de caractères dans chaque ligne doit être maintenu dans les limites de 80, non ; Il devrait y en avoir plus de 120

  • Il ne doit pas y avoir plus d'une déclaration par ligne.

Classes, méthodes, attributs

  • Les espaces de noms et les classes doivent être conformes à la spécification de chargement automatique de PSR : PSR-4 ; 🎜>

    Le code PHP ne doit définir que des déclarations telles que des classes, des fonctions, des constantes, etc. ou définir uniquement d'autres opérations qui produiront des effets subordonnés (comme générer une sortie de fichier, importer des fichiers, modifier des fichiers de configuration ini, etc.), dont les deux seulement Vous pouvez en choisir un ;
  • Le nom de la classe doit suivre la convention de dénomination des cas de chameau de StudyCaps commençant par une majuscule ; 🎜>Toutes les lettres des constantes de la classe doivent être en majuscules, les mots séparés par des traits de soulignement
  • Le nom de la méthode doit être conforme à la convention de dénomination des casses camel en minuscules de style camelCase ; 🎜>
  • L'instruction use doit être située dans l'espace de noms. Après la déclaration, une ligne vide doit être insérée après chaque bloc de déclaration d'espace de noms et le bloc de déclaration use

  • L'ouverture ; les accolades ({) des classes et des méthodes doivent être écrites dans les fonctions. Elles doivent être sur leur propre ligne après la déclaration, et l'accolade fermante (}) doit également être écrite sur sa propre ligne après le corps de la fonction

  • Les mots-clés extends et Implements doivent être écrits sur la même ligne du nom de la classe
  • Chaque instruction ne doit pas définir plus d'un attribut, et le mot-clé var ne doit pas être utilisé pour déclarer un attribut ;
  • Les attributs et méthodes de la classe doivent être ajoutés. Modificateurs d'accès (privé, protégé et public), ne pas utiliser de trait de soulignement _ comme préfixe pour distinguer si l'attribut est protégé ou privé ;
  • Lorsque vous devez ajouter une instruction abstraite ou finale, elle doit être écrite dans le modificateur d'accès avant le caractère, et static doit être écrit après it;
  • Lors de la déclaration et de l'appel de méthodes et de fonctions, il ne doit y avoir aucun espace entre le nom de la méthode ou le nom de la fonction et le crochet gauche du paramètre. Il ne doit y avoir aucun espace après la gauche. crochet et avant le crochet droit. Il doit y avoir un espace après chaque virgule dans la liste des paramètres, et il ne doit y avoir aucun espace avant la virgule.
  • Convention de dénomination PHP
  • Structure de contrôle

Tournage de la structure de contrôle (sinon, sinon if, catch et do... Le mot-clé while) dans la structure while et l'accolade fermante (}) de la structure précédente doivent être écrits sur la même ligne, et il doit y avoir un espace entre eux

Une introduction détaillée à plusieurs points sur les règles de dénomination PHP

L'accolade ouvrante ({) de la structure de contrôle doit être écrite sur la même ligne que la déclaration, et l'accolade fermante (}) doit être écrite sur sa propre ligne après le corps

Il doit y avoir un espace après le mot-clé de la structure de contrôle, et il doit y avoir un espace entre l'accolade droite) et l'accolade ouvrante {
  • Parenthèses conditionnelles après la parenthèse gauche et avant la parenthèse droite Il ne doit y avoir aucun espace, et il doit y avoir un espace entre les deux clauses (après le point-virgule
  • Le corps de chacune) ; la structure doit être entourée de paires d’accolades au milieu.
  • Fermeture
  • L'accolade ouvrante doit être écrite sur la même ligne que la déclaration, et l'accolade fermante doit être écrite immédiatement sur la suivante ligne où se termine le corps ;
  • Lors de la déclaration d'une fermeture, il doit y avoir un espace après le mot-clé function et avant et après le mot-clé use

Liste des paramètres et liste des variables Il ne doit y avoir aucun espace après le crochet gauche et avant le crochet droit
  • Dans les listes de paramètres et de variables, il ne doit pas y avoir d'espace avant la virgule, et il doit y avoir un espace après la virgule.

Variables et mots-clés

  • Tous les mots-clés PHP doivent être tous en minuscules, et les constantes true, false et null doivent également être toutes en minuscules

  • Les opérateurs (=, >, ) pour l'affectation et la comparaison de variables (y compris les instructions conditionnelles et les tableaux de la structure de contrôle) doivent avoir un espace aux deux extrémités, mais l'auto-incrémentation ( ++ ) Décrément (--) Il ne doit y avoir aucun espace entre la variable d'exploitation et le symbole

  • Les déclarations de variables doivent utiliser des lettres minuscules séparées par des traits de soulignement, et les abréviations de mots non universelles doivent ne doit pas être utilisé. Les orthographes ou abréviations autres que l'anglais doivent apparaître

  • array, emtpy, isset, unset et les autres mots-clés entre parenthèses ne doivent pas avoir d'espaces supplémentaires aux deux extrémités

    .
  • La déclaration et l'utilisation du tableau doivent utiliser [] au lieu de array();

  • Besoin d'envelopper la déclaration des variables du tableau et le symbole de début du tableau (); [ ou array() doit être L'opérateur est sur la même ligne. Le premier élément du tableau doit commencer sur une nouvelle ligne et doit être en retrait de la ligne précédente. Le symbole de fin du tableau ([ ou ]) doit commencer sur. une nouvelle ligne et doit être la même que la variable. Alignez le premier caractère

Une introduction détaillée à plusieurs points sur les règles de dénomination PHP

N'oubliez pas votre intention initiale, vous réussirez toujours

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!

Déclaration:
Le contenu de cet article est volontairement contribué par les internautes et les droits d'auteur appartiennent à l'auteur original. Ce site n'assume aucune responsabilité légale correspondante. Si vous trouvez un contenu suspecté de plagiat ou de contrefaçon, veuillez contacter admin@php.cn