Enseignement Informatique du LAL

Indentation

• Indenter correctement votre code

      while(!stream.eof()) {
          std::string s;
          std::getline (stream,s);
          if(s != "FIN_IMAGE")
          {
          std::cout << s << std::endl;
          }
          else 
          {
          std::cout << std::endl;
                    return (true);
                  }                }
            

• est plus clair ainsi :

   while(!stream.eof())
   {
     std::string mot;
     std::getline(stream, mot);
     if(mot != "FIN_IMAGE")
     {
       std::cout << mot << std::endl;
     }
     else 
     {
       std::cout << std::endl;
       return (true);
     }
   }
            

Présentation

• Une seule instruction par ligne !

  •  if (mot != "LARGEUR") { result =  "ATTENTION mot clef LARGEUR manquant ou corrompu"; test = false; return;} 
                  

  • Mais :

     if (mot != "LARGEUR") {
       result =  "ATTENTION mot clef LARGEUR manquant ou corrompu";
       test = false;
       return;
     } 
                  

Initialisation des variables

• Une déclaration de variable doit généralement être suivie de son initialisation
  

   int largeur = 0;

• Evitez les déclarations du type :
  

   int imag, f_larg, f_haut, f_v_p, f_rempl, f_f_imag;
            

• Donnez des noms explicites
  

   int a, b, c;
  			  

  est plus clair ainsi :
  

   int indice = 0;
   int largeur = 0
   int hauteur = 0;
  			  

Accolades

• Ne pas faire suivre une condition ou une boucle par des accolades peut entraîner des confusions et est même source d'erreurs
  Exemple :
  

   for (int y = 0; y < m_nY; y++)
       for (int x = 0; x < m_nX; x++)
         if ((val = GetData(x, y)) < m_min)
           m_min = val;
      
  

• est plus clair ainsi :

   for (int y = 0; y < m_nY; y++) {
       for (int x = 0; x < m_nX; x++) {
         if ((val = GetData(x, y)) < m_min) {
           m_min = val;
         }
       }
   }    
            

Conditions

• Pensez à mettre des parenthèses dans vos conditions
  Exemple :
  

   if (a > 0 && b<0 || c> 0)
              

  
   
  Que fait cette condition ?

•  if ((a > 0 && b<0) || c> 0)   ?
            

•  if (a > 0 && (b<0 || c> 0))   ?
            

Conventions

• Il est essentiel de pouvoir faire immédiatement la distinction entre une variable membre de la classe et une variable locale à la fonction.
  • Variables membres de la classe
    

     protected:
       std::vector < std::vector <int> > m_data;
       unsigned short m_nX;
       unsigned short  m_nY;
       int m_min;
       int m_max;
    

  • Variables locales à la fonction
    

     std::vector < std::vector <int> > data;
     unsigned short nX ;
     unsigned short nY;
     int min;
     int max;
    

• Pour encore plus de clarté, on peut préfixer les arguments des fonctions
  • Par exemple par a_

     void Image::SetData(int a_val, int a_x, int a_y)
    

Gestion d'erreur, Optimisations

• Toujours tester les pointeurs en début de fonction avant de faire des opérations dessus
  
  • sinon, gare aux "null pointer exception" :

     if (ma_forme) {
       ma_forme->clear();
     }
                    

• Utilisez des unsigned int ou lieu de int quand c'est possible
  
  • -> Minimisation de l'espace mémoire
  • -> Minimisation du temps de calcul dans les boucles

   for(unsigned int ind = 0; ind < m_formes.size(); ind++) 
     {
       if (m_formes.at(ind)->Contient(x, y)) {
         return ind;
       }
     }
              

Gestion d'erreur, Optimisations (suite)

• Utilisez des const pour tout argument de fonction non modifiable
  
  • -> Cela vous évitera de les modifier par mégarde
  • -> Optimisation de votre code par le compilateur

   int Image::GetMin() const 
   {
     return m_min;
   }
  

Questions ?