Chapitre 4. Convention de codage

Table des matières
Indentation et longueur de lignes
Structures de Contrôles
Appels de Fonctions
Définitions des fonctions
Commentaires
Inclure du Code
Tags dans le Code PHP
Commentaires d'En-tête
Utilisation de CVS
Exemple d'URLs
Conventions de Nom
Formats des fichiers
E_STRICT-compatible code
Error Handling Guidelines
Meilleure pratique
Fichier d'exemple (incluant les standarts Docblock pour les commentaires)

Note : La convention de codage PEAR s'applique à tout le code qui fait partie de la distribution officielle de PEAR. La convention de codage permet de conserver un code consistent et de le rendre lisible et maintenable facilement par les développeurs PEAR.

Indentation et longueur de lignes

Utilisez une indentation des 4 espaces, sans tabulation. Ceci permet d'éviter les problèmes avec les fichiers diff, les patches, l'historique CVS et les annotations.

Pour Emacs, vous devriez définit le module indent-tabs-mode. Voici un exemple de configuration de ce module (assurez-vous qu'il sera appelé lors de l'édition de fichiers PHP) :
(defun php-mode-hook ()
  (setq tab-width 4
        c-basic-offset 4
        c-hanging-comment-ender-p nil
        indent-tabs-mode
  (not
    (and (string-match "/\\(PEAR\\|pear\\)/" (buffer-file-name))
      (string-match "\.php$" (buffer-file-name))))))

Voici les mêmes réglages pour vim :
set expandtab
set shiftwidth=4
set softtabstop=4
set tabstop=4

Il est recommandé que la longueur des lignes ne dépasse pas 75 à 85 caractères.