PHP - Norme de codage

Chaque entreprise suit une norme de codage différente en fonction de ses meilleures pratiques. Une norme de codage est requise car de nombreux développeurs peuvent travailler sur différents modules, donc s'ils commencent à inventer leurs propres normes, la source deviendra très ingérable et il deviendra difficile de maintenir ce code source à l'avenir.

Voici plusieurs raisons pour lesquelles utiliser des spécifications de codage -

  • Vos pairs programmeurs doivent comprendre le code que vous produisez. Une norme de codage sert de modèle à toute l'équipe pour déchiffrer le code.

  • La simplicité et la clarté obtenues par un codage cohérent vous évitent les erreurs courantes.

  • Si vous révisez votre code après un certain temps, il devient alors facile de comprendre ce code.

  • Sa norme de l'industrie pour suivre une norme particulière pour être plus de qualité dans les logiciels.

Il existe quelques règles à suivre lors du codage en PHP.

  • Indenting and Line Length- Utilisez un retrait de 4 espaces et n'utilisez aucun onglet car différents ordinateurs utilisent des paramètres différents pour l'onglet. Il est recommandé de conserver des lignes d'environ 75 à 85 caractères pour une meilleure lisibilité du code.

  • Control Structures- Celles-ci incluent if, for, while, switch, etc. Les instructions de contrôle doivent avoir un espace entre le mot-clé de contrôle et la parenthèse ouvrante, pour les distinguer des appels de fonction. Vous êtes fortement encouragé à toujours utiliser des accolades, même dans les situations où elles sont techniquement facultatives.

Examples

if ((condition1) || (condition2)) {
   action1;
}elseif ((condition3) && (condition4)) {
   action2;
}else {
   default action;
}

Vous pouvez écrire des instructions switch comme suit -

switch (condition) {
   case 1:
      action1;
      break;
   
   case 2:
      action2;
      break;
         
   default:
      defaultaction;
      break;
}
  • Function Calls- Les fonctions doivent être appelées sans espaces entre le nom de la fonction, la parenthèse ouvrante et le premier paramètre; des espaces entre des virgules et chaque paramètre, et aucun espace entre le dernier paramètre, la parenthèse fermante et le point-virgule. Voici un exemple -

$var = foo($bar, $baz, $quux);
  • Function Definitions - Les déclarations de fonction suivent le "style BSD / Allman" -

function fooFunction($arg1, $arg2 = '') {
   if (condition) {
      statement;
   }
   return $val;
}
  • Comments- Les commentaires de style C (/ * * /) et les commentaires C ++ standard (//) conviennent tous les deux. L'utilisation de commentaires de style Perl / shell (#) est déconseillée.

  • PHP Code Tags- Utilisez toujours <? Php?> Pour délimiter le code PHP, pas le <? ?> sténographie. Ceci est nécessaire pour la conformité PHP et constitue également le moyen le plus portable d'inclure du code PHP sur différents systèmes d'exploitation et configurations.

  • Variable Names -

    • Utilisez toutes les lettres minuscules
    • Utilisez «_» comme séparateur de mots.
    • Les variables globales doivent être précédées d'un «g».
    • Les constantes globales doivent être en majuscules avec des séparateurs «_».
    • Les variables statiques peuvent être précédées de «s».
  • Make Functions Reentrant - Les fonctions ne doivent pas conserver de variables statiques qui empêchent une fonction d'être réentrante.

  • Alignment of Declaration Blocks - Le bloc de déclarations doit être aligné.

  • One Statement Per Line - Il ne devrait y avoir qu'une seule instruction par ligne, sauf si les instructions sont très étroitement liées.

  • Short Methods or Functions - Les méthodes doivent se limiter à une seule page de code.

Il pourrait y avoir beaucoup plus de points à considérer lors de l'écriture de votre programme PHP. Dans l'ensemble, l'intention doit être d'être cohérente tout au long de la programmation du code et cela ne sera possible que lorsque vous suivrez une norme de codage. Vous pouvez installer votre propre standard si vous aimez quelque chose de différent.