[Projet la relance] 14 Conventions de codage

 
void mafonc() {
 ....
#ifdef _WIN32
montrucwindows
#else
montrucposix
#endif
...
}

 
void montruc();
 
void mafonc() {
 
...
montruc()
...
}
 

 
#ifdef _WIN32
void montruc() {
  version windows
}
#else
void montruc() {
  version posix
}
#endif
 

 
int main(int argc, const char** argv) {
   int a = 0;
   // ici je fais le commentaire de la condition
   if( macondi1 && macondi2 && macondi3
    && macondi4 && macondi5 ) {
      // ici je fais le commentaire de la boucle for
      for( int i = 0; i < 12; ++i ) {
        faire des blabla
      }
   } else if( monautrecondi ) {
      // ici je fais le commentaire de la boucle while
      while( trucmachin ) {
        faire des blublu
      }
   }
}
 

 
/**
* Class MyClass
* \brief descriptionBreve
* \author nom ou mail de l'auteur
*/
class MyClass {
   public :
      /**
      * Constructeur par default
      */
      MyClass() ;
 
      /**
      * Destructeur
      */
      ~MyClass() ;
 
      /**
      * Fonction qui fait des bulles
      */
      void doBubbles() ;
 
      /**
      * Recupere le nombre de bulles
      */
      int nbBubbles() const ;
 
      /**
      * Une fonction virtuelle pour la route
      */
      virtual void myVirtual() = 0 ;
 
 
      /**
      * Ensuite une fonction statique
      */
      static float ExplodeAllBuubles() ;
 
    protected :
 
      /**
      * Fonction a acces protege
      */
      void protectedFunc(int paramA, int paramB) ;
 
    private :
      // attribut 1
      int         _attribA;
      OtherClass* _myFriend;
 
};
 
#include "MyClass_inl.h"
 
 

int monAttribut() const ;
void setMonAttribut(int v) ;
 
int _monAttribut;

/**
 * \enum Str_err_e
 * \brief Constantes d'erreurs.
 *
 * Str_err_e est une série de constantes prédéfinie pour diverses futures 
 * fonctions de l'objet Str_t.
 */
typedef enum
{
   STR_NO_ERR,    /*!< Pas d'erreur. */
   STR_EMPTY_ERR, /*!< Erreur: Objet vide ou non initialisé. */
 
   NB_STR_ERR     /*!< Nombre total de constantes d'erreur. */
}
Str_err_e;

Liste des variables
Liste des structures
Liste des procédures
 
Code(s) d'initialisation du programme (Importation, Chargement)
Code principal (Kernel)
Code(s) de fin de programme (Sauvegarde en général)
 
Coupure du programme.

MonchauxantZ.

int main(int argc, const char** argv)
{
   int a = 0;
   // ici je fais le commentaire de la condition
   if(macondi1 && macondi2 && macondi3
       && macondi4 && macondi5) 
   {
      // ici je fais le commentaire de la boucle for
      for(int i = 0; i < 12; ++i)
      {
          faire des blabla
      }
   }
   else if(monautrecondi) 
   {
      // ici je fais le commentaire de la boucle while
      while( trucmachin )
      {
          faire des blublu
      }
   }
}

if(condition1 && condition2
<indent>&& condition3)
{
    // ...
}

J'aimerais que tu explique pourquoi tu es contre l'underscore parceque ca par contre je suis pret à le défendre pendant longtemps. Je trouve que c'est indispensable lorsque l'on implémente les contenu des méthode de toujours être conscient de ce avec quoi on travaille. Et donc de savoir si c'est un attribut ou non, c'est juste une question de clarté m_ c'est trop lourd parcequ'il faut avoir le méchanisme de dire dans sa tête 'm(embre' les premiere fois qu'on le fait alors que l'underscore c pas envahissant et sufisemment distinctif. De plus cela permet de faire des accesseur qui ne porte pas le mot 'get' ce qui est plutôt sympa je trouve.

// Documentation (très) succinte de l'attribut
type _monAttribut;
<un saut de ligne> 
// Doc attr2
int _size;
 
// doc attr3
// ...

void MaClasse::init(int id, float distance) {
   _id = id;
   _distance = distance;
}

 
/**
* Class MyClass
* \brief descriptionBreve
* \author nom ou mail de l'auteur
*/
class MyClass 
{
   public :
      /**
      * Constructeur par default
      */
      MyClass() ;
 
      /**
      * Destructeur
      */
      ~MyClass() ;
 
      /**
      * Fonction qui fait des bulles
      */
      void doBubbles() ;
 
      /**
      * Recupere le nombre de bulles
      */
      int nbBubbles() const ;
 
      /**
      * Une fonction virtuelle pour la route
      */
      virtual void myVirtual() = 0 ;
 
 
      /**
      * Ensuite une fonction statique
      */
      static float ExplodeAllBuubles() ;
 
    protected :
 
      /**
      * Fonction a acces protege
      */
      void protectedFunc(int paramA, int paramB) ;
 
    private :
 
      // attribut 1
      int         _attribA;
 
      // attribut 2
      OtherClass* _myFriend;
 
      // attribut 3
      float       _truc;
 
};
 
inline int MaClass::monInline() const 
{
   return 0;
}
 

 
    while(condition)
      {
    }
 

 
class Truc
{
_>public-:
_>_>Truc()-;
 
_>_>void method()-;
 
_>private-;
 
_>_>int---_mavalint;
_>_>float-_mavalfloat;
 
};
 

int monAttribut() const ;
void monAttribut(int v) ;
 

int monAttribut() const ;

enum E_VIDEO_DRIVER
{
    EVD_DIRECTX,
    EVD_OPENGL,
    EVD_SOFTWARE
}