(29-08-2009, 12:55 PM)NicoMSEvent a écrit : moi par contre, je préfixe mes variables en fonction de leur portée.
g_ pour les gobales
l_ pour les locales
s_ pour les statiques
p_ pour les paramètres passés (éventuellement pi_ po_ pio_ pour les paramètres en entrée/sortie si le langage le permet (comme PL/SQL), sinon en général ma valeur de retour pour une fonction sera tjs l_ret

class Character

  

  @@count = 0 # Ça commence par @@ donc c'est une variable de classe.

  

  # Retourne le nombre de personnages instanciés.

  # Le self.count indique que c'est une méthode de classe.

  def self.count

    @@count

  end

  

  # Constructeur.

  def initialize(name)

    @name = name # Ça commence par @ donc c'est un attribut.

    @@count += 1

  end

  

end



$lang = "fr" # Ça commence par $ donc c'est global.



corwin = Character.new('Corwin') # Quand on ne met rien de spécial, c'est local.

mandor = Character.new('Mandor') # Quand on ne met rien de spécial, c'est local.



puts "#{Character.count} personnages instanciés." # 2

(29-08-2009, 03:11 PM)OncleJames a écrit : Travaillant en équipe et à distance, cette notation nous a fait gagner bien du temps.
Elle ne demande pas de changer le nom, sa fonction, .. juste de préciser ce qu'elle contient.

Dans des listes de fonctions, savoir ce que l'on doit passer en argument juste en regardant son nom, c'est très agréable (et gain de temps par la même occasion, au lieu d'embêter ses voisins à comprendre ce qu'ils ont programmés :non.

Citation :Les commentaires

Il y a 2 types de commentaire:

• Les commentaires du code :Ils servent à savoir ce que fait un bout de code
  
• Les commentaire de génération de doc :Ils servent à générer la doc de toutes les pages, fonctions, classes, méthodes, variables du projet. Pour ces derniers il faut suivre la syntaxe de http://www.PHPdoc.org .
  

Les commentaires doivent être en français car le projet n'a pas pour intention d'accueillir des codeurs non francophone.

Convention de nommage

• Les noms en anglais:
  Il est demandé de nommer les variables, et autre nom de page, méthode ou autre en anglais.
  
  Ceci afin de garder une homogénéité avec le code natif de php
  
  
• Les fichiers contenus dans un sous répertoire (différent de db et doc) doivent porter leur noms, exemple:
  
  Autorisé: /lang/fr/upload.fr.php /index.php /class/upload.class.php /media/css/book.css /media/tpl/book.tpl.php
  
  Interdit: /class/upload.php
  
  
• Les répertoires doivent avoir des noms uniques.
  
  
• Tous les noms doivent être en minuscule.
  
  
• On utilise toujours le _ plutôt que le -.
  

Règle de codage

Code PHP :

<?php 

public static function exemple() {

       while ($ma_condition_ultra_supra_longue_qui_prend_plus_de_80_caracteres)

           echo 'mon instruction se place alors en dessous et indenté';



       $tableaux=array(

           'id'      => 'test',

           'id_long' => 'test',

           'id2'     => 'test',

           'id3'     => 'test'

       );



       if (true) {

           echo 'zut';

           return false;

       }

       else echo 'la ligne est courte pas besoin de mettre en dessous!';  





   } 

• L'indentation doit être de 4 espaces
  
• L'accolade ouvrante doit se trouver sur la même ligne que la structure de contrôle (if,else, switch, while...)
  
• L'accolade fermante doit se trouver au même niveau que la première lettre de l'instruction de la structure de contrôle
  
• Si il n'y a qu'une seul action, les accolades peuvent être omise. Dans ce cas l'actions doit être sur la même ligne que l'instruction de la structure de contrôle OU sur la ligne du dessous avec un décalage d'une indentation si la lisibilité s'en trouve gêné (condition trop longue).
  
• Les longs array doivent être présenté comme dans l'exemple
  
• [TODO] Tris des méthodes (alphabétique?)

<?php 

function test () {

    

    if(...) {

        ...

    }



    return ...

} 

<?php 

function test () 

{

    

    if(...) 

    {

        ...

    }



    return ...

} 

if(true == true){

    echo "Moi j'aime le pâté !";

}

function test () {

}

# Generate a notification frame with the given content.

def notification_tag(message)

  content_tag :div, :class => 'notification' do

    message

  end

end

content_tag :div, :class => 'notification' {

  message

}



content_tag :div, :class => 'notification' do message end



content_tag :div, :class => 'notification' do { message }

(01-09-2009, 08:07 PM)Argorate a écrit : PS: j'imagine bien que c'est pour l'exemple, mais pas d'accolade pour une instruction^^ et pas de guillemet pour un echo de ce genre :p

Si je dis ça, c’est pour empêcher que des gens qui passent vite fait, retiennent des mauvaises choses.

// Mauvaise notation.

echo 'Moi j\'aime le pâté !;



// Bonne notation.

echo "Moi j'aime le pâté !";

// Mauvaise notation.

echo 'Moi j\'aime le ' . nourriture . ' pâté !;



// Bonne notation.

echo "Moi j'aime le {$nourriture} !";

// La notation la plus sale et la plus sensible en terme de maintenabilité.

if(true == true)

    echo "Moi j'aime le pâté !";



// Il y a du mieux, mais c'est toujours pas top pour la maintenabilité.

if(true == true) echo "Moi j'aime le pâté !";



// Un peu plus propre, aucune ambiguïté.

if(true == true){ echo "Moi j'aime le pâté !"; }



// La bonne notation : aucune ambiguïté possible, ni maintenant, ni dans le futur.

if(true == true){

    echo "Moi j'aime le pâté !";

}

<?php 

if (1)

{

    // Code

} 

<?php 

if (1) {

    //code

} 

<?php 

RequestDB( //j'appelle ici a ma couche d'abstraction DB

    sprintf($req_insert_perso

        ,htmlentities($_POST['nom'],ENT_QUOTES,'UTF-8')

        ,htmlentities($_POST['password'],ENT_QUOTES,'UTF-8')

        ,htmlentities($_POST['msg_ok'],ENT_QUOTES,'UTF-8')

        ,htmlentities($_POST['msg_fail'],ENT_QUOTES,'UTF-8')

    )

);



// ======>



function insertTruc($nom, $password, $msg_ok, $msg_fail) {

RequestDB( //j'appelle ici a ma couche d'abstraction DB

    sprintf($req_insert_perso

        ,htmlentities($nom,ENT_QUOTES,'UTF-8')

        ,htmlentities($password,ENT_QUOTES,'UTF-8')

        ,htmlentities($msg_ok,ENT_QUOTES,'UTF-8')

        ,htmlentities($msg_fail,ENT_QUOTES,'UTF-8')

    )

);

}