Clément Delafargue // Divarvel

Dev Web && Hi-Tech && GNU/Linux 

• Clément Delafargue
• Libre.fm
• Flickr
• Twitter

• [Chaîne] Mes habitudes de programmation

  Par divarvel dans Dév. Web le 12 Juillet 2008 à 10:46

  J'ai été gentiment obligé^Wconvié par Skreo à décrire mes petites habitudes en programmation...
  Je m'y attelle donc tout de suite.
  

  Les noms de variables, fonctions, méthodes

  Déjà, j'utilise l'anglais pour nommer mes variables. Pour la capitalisation, tout dépend de si je code Objet ou pas. Si je ne code pas objet, je fais ça à la PHP c'est à dire des mots séparés par des underscore _. Quand je code Objet, j'utilise une CamelCase bidouillée, je mets des majuscules au début de tous les mots, sauf des verbes, ce qui revient très souvent à du lowerCamelCase.

  Indentation

  Indentation de 4, j'indente tout le bloc. Pour le xHTML (je sais, ce n'est pas de la programmation), j'indente le contenu des balises de type bloc (sauf h[1-6]), et je vais à la ligne. Je vais à la ligne après un <br />, sauf s'il y en a plusieurs à la suite (mais c'est plutôt rare que ça arrive)

  Accolades

  Accolade ouvrante à la fin de la ligne de définition de la boucle. Accolade fermante sur une nouvelle ligne, au même niveau que la définition de la boucle.
  Pas d'accolades pour un bloc mono-ligne. (par exemple un if suivi d'une seule instruction).

  Espaces

  Pour les virgules et les point-virgules : pas d'espace avant, un espace après.
  Pas d'espace entre les noms de fonction et la parenthèse ouvrante. Idem pour les boucles.
  Pas d'espace entre la parenthèse fermante et l'accolade ouvrante dans les boucles.
  Pas d'espace entre le else et le if dans les else if.
  Un espace de part et d'autre des opérateurs de modification (=, +=, *=, ...).
  Un espace de part et d'autre pour les opérateurs de comparaison (==, <=, >=) et pour les opérateurs de modification dans les boucles (for, while, if), sauf pour les longues expressions.

  Guillemets

  En php, j'utilise uniquement les guillemets simples (apostrophe), sauf pour afficher des caractères spéciaux (\r, \n ...).
  En JS, ça dépend du contenu de la chaîne. Si c'est du texte tout bête, des guillemets doubles, si ça contient du HTML, je mets des guillemets simples
  Dans les autres langages, des guillemets doubles.

  Commentaires

  Dans les fichiers lambda, des commentaires pour expliquer la fonction d'un bloc, en particulier si c'est tricky
  Dans les fichiers qui définissent les classes, quelques lignes au début, puis un bloc de commentaire avant chaque méthode : utilité, variables attendues (rôle, type, valeur par défaut), valeur de retour, puis éventuellement des commentaires monolignes pour expliquer la fonction de tel ou tel bloc. Les commentaires monolignes pour les blocs sont mis après l'accolade ouvrante, précédés d'un espace.

  <?php
  //Code non_objet
  $premiere_variable = 'Texte';
  function get_property(){ // Cette fonction retourne un truc
      $retour = 'Un truc';
      return $retour;
  }
  //Code objet
  class ClasseBidon{
  /*
  Fonction sayHello
  Sert à dire Hello World
  Arguments : Aucun
  Retourne : string
  */
      public static function sayHello(){
          return 'Hello World !'
      }
  }
  ?>

  [code=php]<?php
  //Code non_objet
  $premiere_variable = 'Texte';
  function get_property(){ // Cette fonction retourne un truc
      $retour = 'Un truc';
      return $retour;
  }
  //Code objet
  class ClasseBidon{
  /*
  Fonction sayHello
  Sert à dire Hello World
  Arguments : Aucun
  Retourne : string
  */
      public static function sayHello(){
          return 'Hello World !'
      }
  }
  ?>[/code]

  Je fais suivre la chaîne à Xipoons, puis à ceux qui sont motivés :p

  
  Partager cet article :
  
  Tags : code, objet, php, habitudes, programmation
  Suivre le flux RSS des commentaires de cet article
  Revenir à la liste des articles
• Commentaires

  1

  xipoons

  14 Juillet 2008 à 20:58

  

  Quand tu utilises des guillemets simples ', il y a pas des dispositions particulières a prendre dès qu'il y a des variables ?
  
  Sinon, merci de m'avoir fait suivre la chaîne, ca m'aurra bien occupé pendant 1/2 heure :) ==> http://tinyurl.com/6newx7

  2

  divarvel

  14 Juillet 2008 à 22:33

  

  L'intérieur des guillemets simples n'est pas interprété, pour les variables, tu fais 'texte'.$variable.'fin du texte'
  

  
  
  Ajouter un commentaire
  
  

  Nom / Pseudo :
  
  E-mail (facultatif) :
  
  Site Web (facultatif) :
  
  Commentaire :
  
  

  
  Recopiez le code inscrit sur l'image :
  
  
  Ce code est un code de sécurité pour empêcher le spam en vérifiant que la personne qui poste est bien un humain et non un robot.