{"id":83,"date":"2015-02-20T09:20:35","date_gmt":"2015-02-20T09:20:35","guid":{"rendered":"http:\/\/anthroponaute.fr\/blog-informatique\/?p=83"},"modified":"2016-08-05T17:03:37","modified_gmt":"2016-08-05T17:03:37","slug":"83","status":"publish","type":"post","link":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/?p=83","title":{"rendered":"Astuces pour bien coder en C++"},"content":{"rendered":"

\"C++-unofficial.sh-600x600\"<\/a><\/p>\n

Intro :<\/strong><\/p>\n

Voici quelques astuces qui vous permettrons de mieux vous organiser dans l’\u00e9tape d’\u00e9criture de votre code.<\/p>\n

Safe Delete :<\/strong><\/p>\n

Pour d\u00e9truire correctement vos objets instanci\u00e9s, vous pouvez utiliser ces macros :<\/p>\n

\r\n\r\n#define SAFE_DELETE(a) { delete (a); (a) = nullptr; }\r\n#define SAFE_RELEASE(x) { x->Release();  (x) = nullptr; }\r\n\r\nSAFE_DELETE(a);\r\nSAFFE_RELEASE(x);\r\n\r\n<\/pre>\n

\nFichier de d\u00e9claration de defines :<\/strong><\/p>\n
Utiliser un fichier include (Defines.h<\/strong>) o\u00f9 vous mettrez toutes vos d\u00e9clarations de defines.
\nPar principe il vaut mieux\u00a0 regrouper ensemble tout ce qui se ressemble.<\/p>\n
\r\n\r\n#define FIRST_PERSON_CAMERA_SPEED 3.0f\r\n#define OGRE_RENDER_SYSTEM_NAME "Direct3D9 Rendering Subsystem"\r\n#define TIME_FADE_ANNOUNCE 2.0f\r\n#define GAME_VERSION_REVISION "2323"\r\n#define GAME_VERSION_MINOR "1"\r\n#define GAME_VERSION_MAJOR "0"\r\n\r\n<\/pre>\n

\nCommentaires :<\/strong><\/p>\n
En g\u00e9n\u00e9ral il vaut mieux bien nommer correctement les noms des variables et des fonctions
\nplut\u00f4t que de mettre des commentaires partout.<\/p>\n
\u00ab\u00a0Really good code comments itself\u00a0\u00bb :<\/p>\n
Sortie de texte pour d\u00e9bugger :<\/strong><\/p>\n
Sous Visual Studio on peut utiliser :<\/p>\n
\r\nOutputDebugString(_T("text"));\r\n\r\n<\/pre>\n
Cela permettra au programme d’\u00e9criture sur la sortie debug de VC++.<\/p>\n

\nEn-t\u00eate :<\/strong><\/p>\n
Pour expliquer et situer le r\u00f4le d’un fichier source vous pouvez cr\u00e9er une en-t\u00eate dans chaque fichier :<\/p>\n
\r\n\r\n\/\/----------------------------------------------------\r\n\/\/ Auteur : Cl\u00e9ment Profit\r\n\/\/ Nom du fichier : Console.cpp\r\n\/\/ Date de cr\u00e9ation : Juillet 2014\r\n\/\/ Description : Une console quake-like avec commandes et\r\n\/\/ appels d'events\r\n\/\/----------------------------------------------------\r\n\r\n<\/pre>\n
Pour expliquer et situer le r\u00f4le d’une m\u00e9thode :<\/p>\n
\r\n\r\n\/\/--------------------------------------------------\r\n\/\/ EventManager::Trigger\r\n\/\/--------------------------------------------------\r\n\r\n<\/pre>\n
 <\/p>\n
Principes :<\/strong><\/p>\n
1 –<\/strong> ne jamais arr\u00eater son travail quand le programme ne fonctionne pas ou lorsqu’il ne compile pas. En effet lors de la reprise ult\u00e9rieure de votre travail vous aurez pas de bug(s) \u00e0 corriger que vous aurez oubli\u00e9s de r\u00e9soudre.<\/p>\n
2 –<\/strong> pensez \u00e0 abuser l\u2019utilisation des macros lorsque votre code devient r\u00e9p\u00e9titif.<\/p>\n
Macro pr\u00e9d\u00e9finies :<\/strong><\/p>\n
Nom de la fonction courante :<\/p>\n
\r\n\r\n#if defined(_MSC_VER)\r\n\u00a0\u00a0\u00a0 #define CURRENT_FUNCTION_NAME __FUNCTION__\r\n#elif defined(__GNUC__) && (__GNUC__ >= 3 )\r\n\u00a0\u00a0\u00a0 #define CURRENT_FUNCTION_NAME __PRETTY_FUNCTION__\r\n#else\r\n\u00a0\u00a0\u00a0 #define CURRENT_FUNCTION_NAME "Unknown function"\r\n#endif\r\n<\/pre>\n
Pour le reste voir l’article Pr\u00e9processeur<\/a><\/p>\n
Assertions :<\/strong><\/p>\n
Utiliser ces assertions un peu partout dans votre code.
\nL’instruction asm { int 3 }<\/strong> indiquera au d\u00e9bogueur un point d’arr\u00eat pr\u00e8s de l’assertion en cause.<\/p>\n
\r\n\r\n#ifndef ASSERT_H\r\n#define ASSERT_H\r\n\r\n#ifndef NDEBUG\r\n\r\n#define AssertMsg(expr, msg) if (!(expr)) { std::wout << (#expr << " " << __FILE__ << " " << __LINE__ << " " << CURRENT_FUNCTION_NAME << " " << msg << std::endl); __asm { int 3 } }\r\n#define AssertNULLPointer(pointer) if (pointer == NULL) { AssertMsg(pointer, #pointer " == NULL"); __asm { int 3 } }\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\r\n#else \/\/! non-debug\r\n\r\n#define AssertMsg(expr, msg) fastprint(msg);\r\n#define SKIP_IF_FAILED_AssertMsg(expr, msg) if (expr)\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \u00a0\r\n#endif\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \u00a0\r\n#endif\r\n\r\n<\/pre>\n
Notations :<\/strong><\/p>\n
Utiliser la notation hongroise pour noter vos variables et vos noms de fonctions :<\/p>\n
g : utiliser pour les variables globales – g_counter
\nm : utiliser pour les variables membres – m_counter
\np : utiliser pour les variables pointeurs – m_pActor
\nV : utiliser pour les fonctions virtuelles – VDraw()
\nI : utiliser pour les classes interfaces – class IDrawable<\/p>\n
Exemple :<\/p>\n
\r\n\r\nOgre::OverlayManager* m_pOverlayManager;\r\nOgre::Overlay* m_pOverlayConsole;\r\nOgre::OverlayContainer* m_pPromptImage;\r\n\r\nstd::string m_sCurrentCommmandLine;\r\nstd::string m_sPrompt;\r\n\r\nfloat m_fScrollYOffset;\r\nfloat m_fHeight;\r\nfloat m_fWidth;\r\nfloat m_fCharWidth;\r\n\r\n<\/pre>\n
Les diff\u00e9rents types de style de codage peuvent \u00eatre source de conflit entre programmeurs.<\/p>\n
L’important est d’\u00eatre r\u00e9gulier<\/strong> dans la beaut\u00e9 de la syntaxe,
\npeu importe quel style \/ norme de codage vous employez.<\/p>\n
Utiliser des raccourcis pour vos classes singletons :<\/p>\n
\r\n\r\n#define EVENT_MANAGER EventManager::getSingletonPtr()\r\n\r\n<\/pre>\n

\nMacro fastprint(texte) :<\/strong><\/p>\n
Pour imprimer du texte ou une variable rapidement (la macro supporte du texte \u00ab\u00a0wide string\u00a0\u00bb c’est-\u00e0-dire supportant l’alphabet fran\u00e7ais contrairement \u00e0 printf ou \u00e0 std::cout).<\/p>\n
\r\n\r\n#define fastprint(msg) std::wcout << #msg " = " << msg << std::endl;\r\n\r\n<\/pre>\n
 <\/p>\n
Macro debugprint(texte) :<\/strong><\/p>\n
Pour d\u00e9boguer vos applications on se sert de cette macro pour afficher facilement une variable<\/p>\n
\r\n#define debugprint(msg) std::cout << msg << " = " << std::endl;\r\n<\/pre>\n
(todo mulitples param\u00e8tres)<\/p>\n
 <\/p>\n
Constructeur :<\/strong><\/p>\n
Ne jamais faire \u00e9chouer l’initialisation d’un objet dans son constructeur.
\nD\u00e9finissez une m\u00e9thode bool Initialize()<\/strong> \u00e0 la place (qui peut \u00e9chou\u00e9e quant-\u00e0-elle) que vous appelez juste apr\u00e8s le \u00ab\u00a0new\u00a0\u00bb et qui renvoit un bool\u00e9en indiquant si ou non l’initialisation de l’objet \u00e0 \u00e9chou\u00e9e.<\/p>\n
DXTrace :<\/strong><\/p>\n
Pour afficher \u00e9ventuellement une erreur DirectX, on peut utiliser cette macro :<\/p>\n
\r\n#if defined(DEBUG) | defined(_DEBUG)\r\n\u00a0\u00a0 \u00a0#ifndef HR\r\n\u00a0\u00a0 \u00a0#define HR(x)\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \\\r\n\u00a0\u00a0 \u00a0{\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \\\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0HRESULT hr = x;\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \\\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0if(FAILED(hr))\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \\\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0{\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \\\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0DXTrace(__FILE__, __LINE__, hr, #x, TRUE); \\\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0}\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \\\r\n\u00a0\u00a0 \u00a0}\r\n\u00a0\u00a0 \u00a0#endif\r\n\r\n#else\r\n\u00a0\u00a0 \u00a0#ifndef HR\r\n\u00a0\u00a0 \u00a0#define HR(x) x;\r\n\u00a0\u00a0 \u00a0#endif\r\n#endif\r\n<\/pre>\n
 <\/p>\n
Const correctness\u00a0 <\/strong>:<\/p>\n
 <\/p>\n
Faire une pause dans le programme : <\/strong><\/p>\n
\r\n\r\n#define WAIT_PROCESS int i; std::cin >> i; \/\/ Ne pas utiliser system("pause"); !\r\n\r\n<\/pre>\n
 <\/p>\n
Utilisation de la fen\u00eatre Outline<\/em> de Visual Studio C++<\/strong> :<\/p>\n
Il est ais\u00e9 de naviguer \u00e0 travers les m\u00e9thode de vos classe avec cette fen\u00eatre.<\/p>\n
\"outlines\"<\/a><\/p>\n
 <\/p>\n
Bien choisir la taille de ses types :<\/strong><\/p>\n
Utilisez uint16<\/strong> <\/em>\u00e0 la place de uint32<\/strong> <\/em>quand cela est possible, cela r\u00e9duira la taille consomm\u00e9e par votre programme \u00e0 l’ex\u00e9cution. Vous pouvez continuer \u00e0 utiliser uint32<\/strong> <\/em>lorsque que la variable est utilis\u00e9e temporairement (par exemple dans les boucles), en effet il n’est pas important d’utiliser des variables de type uint16<\/strong> <\/em>sur la pile car elles sont d\u00e9truites tout de suite<\/strong> apr\u00e8s la port\u00e9e, il faut utiliser des uint16<\/strong> <\/em>uniquement sur le tas.<\/p>\n
\r\n\r\n\/\/ Apr\u00e8s avoir ignorer un bloc de code on nous propose la reprise du programme en cours\r\n#define SKIP_IF_FAILED_AssertMsg(expr, msg) if (!(expr)) \\\r\nFailedAssertMessageBox(#expr, __FILE__, __LINE__, CURRENT_FUNCTION_NAME, msg, true); \\\r\nelse\r\n\r\n<\/pre>\n
R\u00e9sum\u00e9 : <\/strong><\/p>\n
Ces m\u00e9thodes permettent de faciliter le codage de vos programme et de
\nrendre le code plus clair et plus joli.<\/p>\n","protected":false},"excerpt":{"rendered":"
Intro : Voici quelques astuces qui vous permettrons de mieux vous organiser dans l’\u00e9tape d’\u00e9criture de votre code. Safe Delete : Pour d\u00e9truire correctement vos objets instanci\u00e9s, vous pouvez utiliser ces macros : Fichier de d\u00e9claration de defines : Utiliser un fichier include (Defines.h) o\u00f9 vous mettrez toutes vos d\u00e9clarations de defines. Par principe il […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[3],"tags":[],"_links":{"self":[{"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=\/wp\/v2\/posts\/83"}],"collection":[{"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=83"}],"version-history":[{"count":115,"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=\/wp\/v2\/posts\/83\/revisions"}],"predecessor-version":[{"id":5350,"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=\/wp\/v2\/posts\/83\/revisions\/5350"}],"wp:attachment":[{"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=83"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=83"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=83"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}