Style Code - Historique des versions

Lachaud : /* Conventions, structurations et qqs remarques */

2009-11-07T16:00:54Z

Conventions, structurations et qqs remarques

← Version précédente		Version du 7 novembre 2009 à 16:00
Ligne 185 :		Ligne 185 :
	** ajouter un exemple d'utilisation à chaque classe.		** ajouter un exemple d'utilisation à chaque classe.
	** toute classe, méthode, données doit être commentée correctement.		** toute classe, méthode, données doit être commentée correctement.
			** la fiabilité doit être importante, mais je n'ai pas trop de soucis car nous travaillons sur des entiers et nous avons pas de probèmes numériques.
			** La généricité est importante, il faut donc veiller à travailler sur des concepts, réalisés ensuite par des classes.
			** mais la performance est fondamentale... sinon personne n'utilisera cette lib. Ainsi, avant de faire ImaGene, j'avais une bibliothèque qui representait des espaces discrets quelconques, 2D, 3D, réguliers ou non. J'aurai peut-être pu faire mieux, mais en tous cas ce qui est en sorti à l'époque est une usine à gaz, peu rapide pour les images 2D. Je n'ai donc gardé la généricité que sur des espaces cartésiens nD, grâce à un codage des cellules.
	* divers		* divers
	** il faudrait générer nos classes avec un patron, pour être sûr que chaque fois qu'on rajoute du code, on suit la norme choisie. Je vous joins ci-dessous mes patrons :		** il faudrait générer nos classes avec un patron, pour être sûr que chaque fois qu'on rajoute du code, on suit la norme choisie. Je vous joins ci-dessous mes patrons :

Lachaud : /* Conventions, structurations et qqs remarques */

2009-11-07T15:41:15Z

Conventions, structurations et qqs remarques

← Version précédente		Version du 7 novembre 2009 à 15:41
Ligne 167 :		Ligne 167 :

	Un peu en vrac :		Un peu en vrac :
	# nommage		* nommage
	- classes à la JAVA : DiscreteLine		** classes à la JAVA : DiscreteLine
	- méthodes : bool isAligned()		** méthodes : bool isAligned()
	- données membres : m_point		** données membres : m_point
	- constantes majuscules : NB_MAX_POINTS		** constantes majuscules : NB_MAX_POINTS
	- préprocesseur (évité autant que possible), sinon définitions _MYDEF_		** préprocesseur (évité autant que possible), sinon définitions _MYDEF_
	# structuration		* structuration
	-# tout dans un namespace		** tout dans un namespace
	-# découpage ensuite par répertoires (base, math, etc)		** découpage ensuite par répertoires (base, math, etc)
	-# une classe DiscreteLine : DiscreteLine.h DiscreteLine.ih DiscreteLine.cxx. Le fichier .ih contient le code des méthodes inline		** une classe DiscreteLine : DiscreteLine.h DiscreteLine.ih DiscreteLine.cxx. Le fichier .ih contient le code des méthodes inline
	-# pas de fonctions ni de variables globales, plutôt des classes <<utils>>, sauf quelques opérateurs (operator<< par exemple).		** pas de fonctions ni de variables globales, plutôt des classes <<utils>>, sauf quelques opérateurs (operator<< par exemple).
	# intentions		* intentions
	-# avoir des classes <<utils>> Trace, Debug, Timings pour homogéniser la gestion des erreurs.		** avoir des classes <<utils>> Trace, Debug, Timings pour homogéniser la gestion des erreurs.
	-# je n'utilise pas les exceptions en C++ quoique je le fais en JAVA, je ne suis pas contre en avoir.		** je n'utilise pas les exceptions en C++ quoique je le fais en JAVA, je ne suis pas contre en avoir.
	-# ajouter à chaque méthode sa complexité en pire cas, cas moyen, si cette méthode n'est pas O(1).		** ajouter à chaque méthode sa complexité en pire cas, cas moyen, si cette méthode n'est pas O(1).
	-# ajouter un exemple d'utilisation à chaque exécutable.		** ajouter un exemple d'utilisation à chaque exécutable.
	-# ajouter un exemple d'utilisation à chaque classe.		** ajouter un exemple d'utilisation à chaque classe.
	-# toute classe, méthode, données doit être commentée correctement.		** toute classe, méthode, données doit être commentée correctement.
	# divers		* divers
	-# il faudrait générer nos classes avec un patron, pour être sûr que chaque fois qu'on rajoute du code, on suit la norme choisie. Je vous joins ci-dessous mes patrons :		** il faudrait générer nos classes avec un patron, pour être sûr que chaque fois qu'on rajoute du code, on suit la norme choisie. Je vous joins ci-dessous mes patrons :
	-# utiliser Doxygen pour générer la documentation de référence me semble indispensable		** utiliser Doxygen pour générer la documentation de référence me semble indispensable
	-# Doxygen est aussi pas mal pour faire un peu de documentation utilisateur		** Doxygen est aussi pas mal pour faire un peu de documentation utilisateur

	=== Patron de XXX.h ===		=== Patron de XXX.h ===

Lachaud : /* Conventions, structurations et qqs remarques */

2009-11-07T15:38:29Z

Conventions, structurations et qqs remarques

← Version précédente		Version du 7 novembre 2009 à 15:38
Ligne 167 :		Ligne 167 :

	Un peu en vrac :		Un peu en vrac :
		⚫	# nommage

		⚫	- classes à la JAVA : DiscreteLine
⚫	- nommage
		⚫	- méthodes : bool isAligned()
⚫	-# classes à la JAVA : DiscreteLine
		⚫	- données membres : m_point
⚫	-# méthodes : bool isAligned()
		⚫	- constantes majuscules : NB_MAX_POINTS
⚫	-# données membres : m_point
		⚫	- préprocesseur (évité autant que possible), sinon définitions _MYDEF_
⚫	-# constantes majuscules : NB_MAX_POINTS
		⚫	# structuration
⚫	-# préprocesseur (évité autant que possible), sinon définitions _MYDEF_
⚫	- structuration
	-# tout dans un namespace		-# tout dans un namespace
	-# découpage ensuite par répertoires (base, math, etc)		-# découpage ensuite par répertoires (base, math, etc)
	-# une classe DiscreteLine : DiscreteLine.h DiscreteLine.ih DiscreteLine.cxx. Le fichier .ih contient le code des méthodes inline		-# une classe DiscreteLine : DiscreteLine.h DiscreteLine.ih DiscreteLine.cxx. Le fichier .ih contient le code des méthodes inline
	-# pas de fonctions ni de variables globales, plutôt des classes <<utils>>, sauf quelques opérateurs (operator<< par exemple).		-# pas de fonctions ni de variables globales, plutôt des classes <<utils>>, sauf quelques opérateurs (operator<< par exemple).
	- intentions		# intentions
	-# avoir des classes <<utils>> Trace, Debug, Timings pour homogéniser la gestion des erreurs.		-# avoir des classes <<utils>> Trace, Debug, Timings pour homogéniser la gestion des erreurs.
	-# je n'utilise pas les exceptions en C++ quoique je le fais en JAVA, je ne suis pas contre en avoir.		-# je n'utilise pas les exceptions en C++ quoique je le fais en JAVA, je ne suis pas contre en avoir.
Ligne 186 :		Ligne 185 :
	-# ajouter un exemple d'utilisation à chaque classe.		-# ajouter un exemple d'utilisation à chaque classe.
	-# toute classe, méthode, données doit être commentée correctement.		-# toute classe, méthode, données doit être commentée correctement.
	- divers		# divers
	-# il faudrait générer nos classes avec un patron, pour être sûr que chaque fois qu'on rajoute du code, on suit la norme choisie. Je vous joins ci-dessous mes patrons :		-# il faudrait générer nos classes avec un patron, pour être sûr que chaque fois qu'on rajoute du code, on suit la norme choisie. Je vous joins ci-dessous mes patrons :
	-# utiliser Doxygen pour générer la documentation de référence me semble indispensable		-# utiliser Doxygen pour générer la documentation de référence me semble indispensable

Lachaud le 7 novembre 2009 à 15:35

2009-11-07T15:35:18Z

← Version précédente		Version du 7 novembre 2009 à 15:35
Ligne 185 :		Ligne 185 :
	-# ajouter un exemple d'utilisation à chaque exécutable.		-# ajouter un exemple d'utilisation à chaque exécutable.
	-# ajouter un exemple d'utilisation à chaque classe.		-# ajouter un exemple d'utilisation à chaque classe.
			-# toute classe, méthode, données doit être commentée correctement.
	- divers		- divers
	-# il faudrait générer nos classes avec un patron, pour être sûr que chaque fois qu'on rajoute du code, on suit la norme choisie. Je vous joins ci-dessous mes patrons :		-# il faudrait générer nos classes avec un patron, pour être sûr que chaque fois qu'on rajoute du code, on suit la norme choisie. Je vous joins ci-dessous mes patrons :
	-# utiliser Doxygen pour générer la documentation de référence me semble indispensable		-# utiliser Doxygen pour générer la documentation de référence me semble indispensable
	-# Doxygen est aussi pas mal pour faire un peu de documentation utilisateur		-# Doxygen est aussi pas mal pour faire un peu de documentation utilisateur



	=== Patron de XXX.h ===		=== Patron de XXX.h ===

Lachaud : Ajout des conventions de JOL

2009-11-07T15:29:40Z

Ajout des conventions de JOL

Voir les modifications

Dcoeurjo le 6 novembre 2009 à 08:32

2009-11-06T08:32:33Z

@@ Ligne 24 : / Ligne 24 : @@
       ...
+   }
    int is_valid()
@@ Ligne 35 : / Ligne 36 : @@
 </source>

Dcoeurjo le 5 novembre 2009 à 10:41

2009-11-05T10:41:42Z

Nouvelle page

= Guillaume D. (CGAL like) =

<source lang=cpp>
/**
* Nom des classes, type, et paramètres templates avec 1ère lettre majuscule
* (tout le reste 1ère lettre minuscule)
* des _ entre les mots
* variables membres commencent par m
* variables paramètres commencent par a
* constantes en majuscules
* indentation : { et } sur la même colonne que le dessus et à
* l'intérieur décalage (type ANSI)
**/

template <Type>
class Object_toto
{
public:
Object_toto(const Object_toto& atoto)
{
...
code
indenté
...
}

int is_valid()
{}

private:
Type mdata;

static const int MA_CONSTANTE;
}

</source>

Style Code - Historique des versions

Lachaud : /* Conventions, structurations et qqs remarques */

Lachaud : /* Conventions, structurations et qqs remarques */

Lachaud : /* Conventions, structurations et qqs remarques */

Lachaud le 7 novembre 2009 à 15:35

Lachaud : Ajout des conventions de JOL

Dcoeurjo le 6 novembre 2009 à 08:32

Dcoeurjo le 5 novembre 2009 à 10:41

Lachaud : /* Conventions, structurations et qqs remarques */

Lachaud : /* Conventions, structurations et qqs remarques */

Lachaud : /* Conventions, structurations et qqs remarques */

Lachaud : Ajout des conventions de JOL