Conventions de codage

A l’instar de beaucoup, j’écope d’une chaine me demandant de décrire mes conventions de codage. Je code régulièrement du PHP, CSS, Javascript et autre HTML, je vais donc me contenter de ceux ci (pour le reste, Perl, Java, shell … je ne suis pas vraiment à la page … on est si vite largué de nos jours).

Mise au point

L’intérêt d’utiliser des conventions de codages reste l’homogénéisation du code dans un projet. Comme NiKo, on pourrait résumer qu’il faut utiliser les normes du projet dans lequel vous travaillez. Toutefois, voici mes modestes habitudes.

PHP

Grosso modo je fais à peu près comme tout le monde (et c’est tant mieux). J’ai tendance à utiliser lowerCamelCase pour les noms de classe en les préfixants par catégorie (un peu comme le @package de PHPDoc) à l’exception des classes du modèle ou j’utilise UpperCamelCase. A la réflexion cela peut venir de l’époque ou, en PHP, on n’utilisait des classes que pour coder la partie modèle de MVC et ou PEAR recommandait UpperCamelCase.

Je mets un point d’honneur à faire en sorte que le minimum vital de PHPDoc soit respecté, en particulier les @return et @param qui aliment l’autocomplétion des éditeurs de code.

A noter que le projet phpcs permet de contrôler assez facilement des standards de codage PHP. (à mettre en oeuvre pour tous les projets d’envergure, phpcs est très dynamique et mérite que l’on s’y attarde).

Javascript et CSS

J’utilise les mêmes conventions que l’oncle Tom (quel beau prénom !).

Pas grand chose à dire si ce n’est que j’ai rencontré peu de projets ou il m’a fallu faire beaucoup de Javascript très spécifiques. A mon avis ce genre de travail nécessite des compétences excessivement pointus que malheureusement peu de développeurs désire acquérir.

HTML

Bon, personne n’en a vraiment parlé, et je trouve que pourtant il y a des choses à faire de ce coté. Pour les langages précédent, si votre code est bien structuré et découpé, même sans quelque chose de très homogène au niveau de la façon de coder, il sera tout de même facile de l’exploiter. Dans le cas de HTML on ne coltine souvent de gros paquets de codes indigestes.

Pour ma part, j’indente le code un peu au pif. La seule convention que j’utilise, je l’ai piqué à mon collègue beauminou. Elle consiste à indiquer les fermetures de tags importants afin de plus facilement s’y retrouver dans l’imbriquation du DOM. Par exemple :

tout plein de code ici

Si certains ont des idées pour améliorer ça, n’hésitez pas à m’en faire part !

Et comme les-chaines-j’ai-du-mal celle ci ce brise ici 😉

Publicités

Une réflexion au sujet de « Conventions de codage »

  1. Hugo

    Pour le HTML, j’utilise des classes pour identifier tout ce qui sera mis en forme grâce aux CSS et je ne garde les ID que lorsque je sais que je devrais atteindre l’élément depuis Javascript et le DOM.

    en gros ça peut me donner ça :

    # HTML

    Mon beau site

    # CSS
    .top {

    }

    .header {

    }

    # JS
    var header = document.getElementById(‘header’);

    Répondre

Laisser un commentaire

Entrez vos coordonnées ci-dessous ou cliquez sur une icône pour vous connecter:

Logo WordPress.com

Vous commentez à l'aide de votre compte WordPress.com. Déconnexion / Changer )

Image Twitter

Vous commentez à l'aide de votre compte Twitter. Déconnexion / Changer )

Photo Facebook

Vous commentez à l'aide de votre compte Facebook. Déconnexion / Changer )

Photo Google+

Vous commentez à l'aide de votre compte Google+. Déconnexion / Changer )

Connexion à %s