DokuWiki

It's better when it's simple

Outils pour utilisateurs

Outils du site


Panneau latéral

Cette traduction est plus ancienne que la page originale et est peut-être dépassée.
Traductions de cette page?:

Découvrir DokuWiki

Options avancées

Pour les entreprises

Notre Communautée


Suivez-nous sur Facebook, Twitter et les autres résaux sociaux.

Notre politique de confidentialité

fr:devel:coding_style

Style de programmation

Je ne suis pas très strict sur la manière dont le code doit être présenté, mais certaines conventions doivent être respectées pour ajouter du code à DokuWiki.

Accolades et indentation

L'indentation de votre code devrait être de 2 ou 4 espaces pour marquer les blocs logiques. Merci de ne pas utiliser de tabulation. La même indentation doit être utilisée tout le long d'un même fichier : vérifiez combien d'espaces sont utilisées dans le code existant pour adopter la même convention.

Les accolades ouvrantes doivent commencer sur la même ligne que le mot-clef qui la précède, l'accolade fermante doit être alignée avec la première lettre de ce mot-clef. Par exemple :

if ($foo == "bar"){
  call_bar();
}elseif($foo == "baz"){
  call_baz();
}else{
  call_other();
}

Fins de lignes

Les lignes doivent se terminer avec un caractère de fin de ligne (à la façon UNIX). Essayez d'éviter les espaces en fin de ligne : vous pouvez consulter mon fichier vimrc pour voir comment les détecter facilement avec VIM.

Commentaires

Chaque fonction et chaque classe doit avoir un commentaire pour PHPDocumentor, qui indique au moins le but de la fonction et son auteur. Il est agréable d'avoir une description pour les paramètres et la valeur de retour, mais elle n'est obligatoire que lorsqu'elle n'est pas évidente. Si vous améliorez une fonction existante, ajoutez simplement une nouvelle ligne d'auteur.

Exemple:

/**
 * Check for foo in bar
 *
 * Checks if there is a foo in bar
 *
 * @author   Joe Schmoe <joe@example.com>
 * @param    string $in your input
 * @returns  boolean    true if foo in bar
 */
function is_foo($in){
...
}

Ces commentaires sont utilisées pour la documentation de l'API générée automatiquement.

Balises fermantes de PHP

Vous devez omettre la balise fermante de PHP (?>) dans tous les fichiers, pour ne pas envoyer prématurément de texte en sortie. Cette pratique peut sembler étrange mais elle est en fait mentionnée dans le manuel de PHP:

Note: La balise fermante d'un bloc PHP à la fin d'un fichier est optionnelle, et parfois, il est utile de l'omettre lors de l'utilisation de la fonction include() ou de la fonction require(), car les espaces non désirés n'apparaîtront pas à la fin des fichiers, et ainsi, vous pourrez toujours ajouter des en-têtes à la réponse plus tard. C'est utile également si vous voulez utiliser la mise en tampon de la sortie et que vous ne voulez pas voir d'espaces blanches ajoutées à la fin des parties générées par les fichiers inclus.

fr/devel/coding_style.txt · Dernière modification: 2008-08-10 12:02 par chi