Vous êtes ici: Accueil » Developer » Convention de codage

Convention de codage

Histoire de mettre un peu d'ordre, voici une petite convention de codage. Ce genre de règles, à première vue un peu contraignante, permet d'avoir un code propre sur lequel on prend plaisir à intervenir.

Variables

Les variables sont composées de mots anglais.

$utilisateur = 'smith'; // à éviter
$user = 'smith'; // c'est mieux :)

Les variables seront toujours écrites en minuscules. Une variable peux être composée de deux mots maxi, séparés par un tiret-bas.

$usrDir = '/home/smith'; // à éviter
$user_dir = '/home/smith'; // c'est mieux :)

On essayera de toujours choisir un nom de variable adéquate.

array($var1, $var2); // à éviter...
array($user_name, $user_login); // c'est plus sympa

Indentation

Il est très important de bien indenter son code, pour de simples questions de lisibilité. L'indentation se fait en tabulation correspondant à 4 espaces (la plupart des bons éditeurs du marché ont des valeurs d'indentation paramétrables) et l'indentation se fera en tabulation vrais, et non pas en espace.

Structure de contrôle

Les structures de contrôle seront écrites de la manière suivante, l'accolade ouvrante se trouvant sur la première ligne, avec un espace entre la parenthèse et l'accolade.

<?php
if (condition1 && condition1) {
    // some action
}
 
foreach ($user_array as $key => $value) {
    // some action
}
?>