This repository has been archived by the owner on Jun 20, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
CODING
93 lines (68 loc) · 1.58 KB
/
CODING
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
== Header Type ==
= Nom du fichier =
* EHeader.hpp : Enumération EHeader
* SHeader.hpp : Structure SHeader
* IHeader.hpp : Interface IHeader
* header.hpp : Classe Header
= Unicité =
Au début de chaque header, penser à écrire :
#ifndef _HEADER
#define _HEADER
...
#endif
= Commentaires =
Chaque header doit être documenté selon la norme Doxygen (http://franckh.developpez.com/tutoriels/outils/doxygen/).
C'est à dire par exemple :
/*!
* \file IMenuToMain.hpp
* \brief Interface Entrée du programme - Menu
* \author Maxime GUIHAL
*/
= Espace de nommage =
Inclure tous les objets du programme dans le namespace PolyBomber :
namespace PolyBomber
{
...
}
== Classe Type ==
Toutes les classes devront respecter la forme de Coplien, et documentées en français.
/*!
* \class Test
* \brief Description courte
*
* Description longue
*/
class Test : public Father
{
public:
int run();
protected:
int a; /*!< Description courte de l'attribut */
private:
/*!
* \brief Description courte
*
* Description longue
*
* \param a : description du paramètre
* \param b : idem
* \return description du retour
*/
int func(int a, int b);
};
int Test::run()
{
...
}
= Includes =
Au début de chaque fichier .cpp, les #include doivent se faire dans l'ordre suivant :
- Bibliothèque standard (genre iostream, etc...)
- Ligne vide
- Bibliothèque SFML
- Ligne vide
- Autres bibliothèques externes
- Ligne vide
- Headers du projet
using namespace PolyBomber;
== Noms des objets ==
Les noms des objets doivent être écrits en anglais et en lowerCamelCase.