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
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 (soit distribuée avec PHP, soit disponible en téléchargement depuis les archives PHP PEAR).

Indentation et longueur de lignes

Utilisez une indentation de 4 espaces, sans tabulations. Si vous utilisez Emacs pour éditer le code PEAR, vous devez fixer le paramètre indent-tabs-mode à 'nil'. Vous trouverez ici un exemple de configuration Emacs pour respecter ces recommandations (vous devrez vous assurer qu'elle est bien appelée lorsque vous éditerez les 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. Il n'y a pas de règles fixes par rapport aux retours à la ligne, mais vous pouvez utiliser votre bon jugement. En cas de doutes, vous pouvez toujours demander sur la liste de diffusion PEAR Quality Assurance (Écrivez en anglais).