Le blog de Vincent Battaglia

Tiens, c’est marrant, j’allais justement faire un post un de ces quatre sur mes conventions de programmation, histoire de vous demander votre avis et pour voir quelles sont les vôtres. Même si je n’ai pas été invité à la fête, cette chaîne initiée par Godefroy et relayée par Babozor tombe à point nommé et je la reprends !

Tout d’abord, allez jeter un coup d’oeil à cet exemple de code PHP que j’ai écrit pour le site Pikaboo.

Notations

J’utilise des notations relativement standard : UpperCamelCase pour les noms de classes et lowerCamelCase pour les noms de fonctions et méthodes. Par contre, pour les variables, j’écris tout en minuscules et je sépare les mots par le caractère underscore. Depuis peu, j’essaye également d’utiliser cette notation (minuscules + underscore) pour les class et id en HTML (afin de répercuter cette notation en CSS).

Indentation

J’indente uniquement par tabulation (de la taille de quatre espaces), aussi bien pour PHP et JavaScript que pour HTML et XML. Je trouve qu’il s’agit du truc le plus important pour obtenir un code lisible. Dans certains langages (Python par exemple), il est même obligatoire de travailler de cette façon.

Accolades

Ma façon de placer les accolades me vient de je ne sais où mais je la trouve efficace : je place l’accolade ouvrante à la fin de la ligne contenant la déclaration de fonction ou la structure de contrôle (if, while, foreach, etc.), précédée par un espace. Par exemple :

foreach (...) {
...
}

ou

function myFunction(...) {
...
}

Autre détail important : même si le contenu d’une condition ou d’une boucle comporte une seule instruction, j’utilise les accolades. Cela évite de les ajouter si on rajoute une instruction mais ça évite surtout des arrachages de cheveux futurs.

Espaces

La, c’est un peu freestyle. J’utilise parfois des espaces pour séparer les paramètres dans une fonction, séparer les instructions dans une boucle for, autour des opérateurs de comparaison mais pas toujours ! Ca doit dépendre de mon humeur du moment… Par contre, je place un espace après le nom des structures de contrôle pour ne pas les confondre avec des déclarations de fonction (voire les exemples plus haut).

Guillemets

J’utilise toujours les simple quotes sauf si je n’ai pas le choix : variable dans la chaîne, tabulation (\t), retour à la ligne (\n) ou retour chariot (\r), etc. Ce n’est pas seulement une convention, c’est plus performant de bosser comme ça (enfin, c’est ce qu’on m’a dit, je n’ai pas fait de benchmarks, j’avoue).

Commentaires

Je suis mauvais élève pour ça. J’écris peu de commentaires. Je me dis toujours que je commenterai comme un fou et que je générerai de la documentation avec phpDoc mais je le fais rarement (jamais en fait). Par contre, quand un client m’ennuie, je mets des insultes à son égard dans les commentaires (je déconne).

En gros, je suis assez pointilleux sur certains points mais pas du tout sur d’autres. Y a t-il de bonnes pratiques officielles à ce sujet ? Quoi qu’il en soit et je répète ce que j’ai déjà lu à de nombreux endroits : peu importe la convention qu’on utilise, l’important est d’en suivre une et de s’y tenir.

Je refile la chaîne à qui le veut.

On est souvent impressionné par l’aspect graphique d’un site Web. C’est ce qu’on voit en premier et c’est donc naturel qu’il en soit ainsi. Je n’ai jamais vu quelqu’un être impressionné par l’intégration, l’optimisation sur les moteurs de recherche ou le développement d’un site Web au premier coup d’oeil…

Pourtant, sur certains sites, il est possible de voir directement que le travail de développement est colossal et, avec un sentiment de respect melé avec de la jalousie, la première question qu’on se pose est : « Comment ont-ils fait ? »

Aujourd’hui, j’ai décidé de vous présenter deux sites qui m’ont tapé dans l’oeil au niveau développement. Je vais tenter de vous montrer comment ils ont été réalisés, en supposant que la technologie utilisée côté serveur est PHP.

Le premier site est Is it Christmas?, un site qui va, via un calcul savant, vous dire si le jour courant est le jour de Noël ou pas. Si vous ne souhaitez pas revenir chaque jour sur le site pour vérifier, vous pouvez même suivre le flux RSS !

Voilà à quoi pourrait ressembler le code source de ce site :

<?php
$today = getdate();
$answer = (($today['mday'] == 25) && ($today['mon'] == 12)) ? 'YES' : 'NO';
echo $answer;
?>

Tout d’abord, je récupère la date du jour avec la fonction getdate de PHP. Cette fonction me renvoie un tableau où se trouve toutes les informations du jour courant. Ensuite, je vérifie que le jour courant est le 25 décembre, jour de Noël. Pour ce faire, je regarde si le jour du mois courant est le 25 (via $today['mday']) et si le mois courant est 12 (via $today['mon']) c’est-à-dire décembre. Si nous sommes le 25/12, la variable $answer aura la valeur YES. Dans tous les autres cas, elle aura la valeur NO. J’ai écrit ce script en trois lignes mais il est sans doute possible de le faire intelligemment en une ligne. J’attends vos propositions.

Le second site impressionnant dont je vais vous faire le making of est Sometimes Red, Sometimes Blue, un chef d’oeuvre dont je vous avais déjà parlé par le passé. Le principe de ce site est le suivant : parfois il est rouge, parfois il est bleu.

Voilà à quoi pourrait ressembler le code source de ce site :

<?php
$color_list = array("#0000FF", "#FF0000");
$color = $color_list[rand(0,count($color_list)-1)];
?>
<html>
<body style="background:<?= $color ?>;"></body>
</html>

Nos deux couleurs sont stockées dans le tableau $color_list. La partie compliquée se trouve entre les crochets. On y génère un nombre aléatoire entre 0 et 1 (c’est-à-dire 0 ou 1) ce qui va nous permettre de récupérer une des deux couleurs stockées dans le tableau. Il reste enfin à afficher cette couleur en fond de la page. De nouveau, il est possible de faire plus concis. J’attends vos propositions.

Pourquoi ce billet ?

* Pour rire
* Pour montrer qu’on peut TOUT faire en PHP
* Pour montrer que deux lignes de code suffisent pour créer un buzz.