Magazine Internet

Mes conventions de codage en PHP

Publié le 31 août 2008 par Kphoen

Je profite du fait que j’ai récemment eu à « réfléchir » (c’est un bien grand mot, je vous le concède) à ce sujet pour exposer publiquement mes habitudes de programmation en PHP.

Généralités

J’utilise toujours les tags longs et en minuscules (<?php … ?>). Vous ne verrez jamais un de mes codes commencer par un short tag (<? …. ?>) ou un tag en majuscules (<?PHP … ?>).
Un fichier définissant une class sera nommé selon le modèle « NomDeLaClass.class.php » en vue de faciliter l’utilisation de la méthode __autoload().
En ce qui concerne l’indentation, 4 espaces me suffisent pour marquer un niveau.

Structures de contrôle

Pour les instructions if, switch, for, while, foreach, etc. je laisse un espace entre le mot clé de l’instruction et la condition. Les accolades occupent à elles seules une ligne.
Si une seule instruction est soumise à condition, j’omets souvent les accolades.
Exemple :

<?php
if (condition1 AND condition2)
{
    //action;
    //action;
}
 
if (condition1 AND condition2)
    //action;
 
foreach ($tableau as $key => $value)
{
    //action;
    //action;
}
?>

Définitions des fonctions

Comme pour les structures de contrôle, les accolades de la fonctions sont placées sous le nom de la fonction et le code est indenté d’un niveau. Les paramètres sont espacés d’un seul espace, et je spécifie la valeur d’un paramètre optionnel en joignant avec le signe « = » et sans espace la définition du paramètre et sa valeur par défaut.
Exemple :

function somme($var1, $var2=0)
{
    return $var1+$var2;
}

Utilisation des fonctions

Les fonctions sont appelées sans aucun espace entre le nom de la fonction et les parenthèses. Cependant, un espace sépare chaque paramètre.
Si la fonction est retournée dans une variable, on mettra au moins un espace de part et d’autre du signe égal.
Exemple :

<?php
$ma_var = ma_fonction($var1, $var2);
fait_quelque_chose();
?>

Règles de nommage

Les noms des variables doivent avoir un sens et ne pas commencer par « _ ». Les mots sont en minuscules et séparés par un underscore, tout comme les fonctions.

Les noms de class sont en CamelCase et doivent aussi (évidemment ? =p) avoir un sens.

Commentaires

Là, j’avoue que c’est un peu freestyle Je commente souvent assez bien les fonctions et méthodes de class, mais le reste du code est assez peu voire pas du tout commenté (honte à moi d’ailleurs).
Exemple de commentaire d’une fonction :

<?php
/**
 * Envoi d'un mail au format HTML
 * @param string $dest adresse mail du destinataire
 * @param string $titre sujet du mail
 * @param string $cont contenu du mail
 * @return bool
 */
?>

Voilà, le principal est dit, n’hésitez pas à me poser des questions, à critiquer mes habitudes et aussi à nous expliquer les votres

;)


Vous pourriez être intéressé par :

Retour à La Une de Logo Paperblog

Ces articles peuvent vous intéresser :

A propos de l’auteur


Kphoen 5 partages Voir son profil
Voir son blog

l'auteur n'a pas encore renseigné son compte l'auteur n'a pas encore renseigné son compte l'auteur n'a pas encore renseigné son compte

Magazine