Norme de codage

Norme de codage
Structure
  • N'oubliez pas d'ajouter un espace unique après chaque point-virgule (;)
  • Toujours ajouter un seul espace autour (avant et après) les opérateurs binaires, les opérateurs de concaténation (comme le point (.) Etc.). Exemple : if (a == b)
  • Utilisez une comparaison identique à moins que vous ayez besoin de faire de la jonglerie.
  • Toujours utiliser les conditions Yoda lors de la manipulation d'une variable pour éviter un changement accidentelle des valeurs de celle-ci à l'intérieur de la déclaration, nous pouvons également vérifier automatiquement le type de données.
  • N'oubliez pas d'ajouter une virgule (,) après chaque élément de tableau dans un tableau multi-lignes, y compris le dernier élément.
    [
         1 => 'Premier élément',
         2 => 'Deuxième élément',
    ];
  • Ajoutez une ligne vierge avant chaque instruction de retour (return), ignorez-le si l'instruction de retour est seule dans un bloc d'instructions
    if ($a === $b) {
    $c = $a + $b;

    return $c;
    }

    if ($a === $b) {
    return true;
    }

  • Utilisez des accolades pour indiquer le corps de la structure de contrôle indépendamment du nombre d'instructions qu'il contient
  • Déclarez les méthodes publiques d'abord, puis protégées et enfin privées. Les exceptions à cette règle sont le constructeur de classe et les méthodes setUp () et tearDown () du PHPUnit tests
  • La Fonction et tous ses arguments devraient être sur la même ligne, peu importe le nombre d'arguments.
  • Utilisez toujours Sprinf pour imprimer des exceptions et le message d'erreur.
Conventions de déclaration
  • En déclarant la variable, la fonction et les arguments, utilisez toujours camelCase, n'utilisez pas les caractères de soulignement
  • En déclarant les noms optionnels et les paramètres n’oubliez pas d'utiliser la mise en relief
  • Utilisez les espace-noms pour toutes les classes en haut de la classe
  • La classe abstraite devrait avoir un préfixe avec abstrait
  • L'interface devrait avoir un suffixe avec interface, même pour les traits et les exceptions
  • Les noms de fichiers doivent contenir des caractères alphanumériques et des caractères de soulignement
  • Toujours écrire PHPDOC pour toutes les fonctions ou méthodes