Wall of Deads - Game development team Forum Index

Wall of Deads - Game development team


 FAQFAQ   SearchSearch   MemberlistMemberlist   UsergroupsUsergroups   RegisterRegister 
 ProfileProfile   Log in to check your private messagesLog in to check your private messages   Log inLog in 

Conventions

 
This forum is locked: you cannot post, reply to, or edit topics.   This topic is locked: you cannot edit posts or make replies.    Wall of Deads - Game development team Forum Index -> Archives
Previous topic :: Next topic  
Author Message
Pierre Moreau
Développeurs

Offline

Joined: 01 Feb 2013
Posts: 534
Point(s): 0
Moyenne de points: 0.00

PostPosted: Mon 4 Feb - 14:26 (2013)    Post subject: Conventions Reply with quote

Codage :
* les noms doivent être explicites et pas trop long (11 max, à voir à l'usage)
* nom de fonctions : ceciEstUneFonction
* nom de paramètres commence par un _
* pour les attributs, utiliser this
* faire attention à final, private, protected, ...

Commentaires :
* doxygen, mettre les balises dans une copie du code de contenant que les prototypes (javadoc)
* si fonction trop longue (sup à 15 lignes), détailler les étapes ou découper en plusieurs sous-fonctions

Autres :
* indentation parfaite
* utilisation d'Eclipse
* découpage en classes, ...
* implémenter les tris, ...


Last edited by Pierre Moreau on Sat 22 Jun - 20:37 (2013); edited 2 times in total
Back to top
Publicité






PostPosted: Mon 4 Feb - 14:26 (2013)    Post subject: Publicité

PublicitéSupprimer les publicités ?
Back to top
Koupur
Développeurs

Offline

Joined: 02 Feb 2013
Posts: 126
Point(s): 3
Moyenne de points: 0.02

PostPosted: Mon 4 Feb - 15:37 (2013)    Post subject: Conventions Reply with quote

ok ça me va Smile
_________________
"Ph'nglui mglw'nafh Cthulhu R'lyeh wgah'nagl fhtagn"


Back to top
Jules
Développeurs

Offline

Joined: 02 Feb 2013
Posts: 384
Point(s): 3
Moyenne de points: 0.01

PostPosted: Mon 4 Feb - 16:56 (2013)    Post subject: Conventions Reply with quote

Doxygene ça nous force la licence non ?
_________________
Hey ! Tu sais quoi ?
. . .

T'as perdu !! Smile


Back to top
Pierre Moreau
Développeurs

Offline

Joined: 01 Feb 2013
Posts: 534
Point(s): 0
Moyenne de points: 0.00

PostPosted: Mon 4 Feb - 22:10 (2013)    Post subject: Conventions Reply with quote

Euh... No idea. Sauf qu'en fait, il y a JavaDoc, qui fait la même chose, et qui est gérée en partie par Elipse, donc on vqa plutôt utiliser JavaDoc.

Back to top
Jules
Développeurs

Offline

Joined: 02 Feb 2013
Posts: 384
Point(s): 3
Moyenne de points: 0.01

PostPosted: Tue 5 Feb - 00:14 (2013)    Post subject: Conventions Reply with quote

ok 
_________________
Hey ! Tu sais quoi ?
. . .

T'as perdu !! Smile


Back to top
Pierre Moreau
Développeurs

Offline

Joined: 01 Feb 2013
Posts: 534
Point(s): 0
Moyenne de points: 0.00

PostPosted: Mon 15 Jul - 11:41 (2013)    Post subject: Conventions Reply with quote

Un truc que j'avais zappé, mais sur lequel il serait bon de revenir, sont les conventions de codage ! Je mets une nouvelle liste ci-dessous, dites moi ce que vous en pensez (j'appliquerai les modifs ensuite sur le logger histoire qu'il s'y conforme) :

Codage :
  • les noms doivent être explicites et pas trop long ;
  • nom de fonctions : ceciEstUneFonction ;
  • nom de paramètres commence par un 'p_' ;
  • nom d'attributs commence par un '_' ;
  • utiliser dès que possibles les const, ça permet d'éviter des erreurs, les références, pour passer des objets en paramètres ;
  • faire attention aux droits d'accès (public, protected, private) ainsi qu'au virtuel ;


Commentaires :
  • utilisation de doxygen ;
  • si fonction trop longue (sup à 15 lignes), détailler les étapes ou découper en plusieurs sous-fonctions ;
  • n'hesitez pas à écrire la doc en même temps que vous écrivez vos fonctions, même si vous ne faites que le minimum (à savoir le nom de la fonction, ses paramètres et à quoi ils correspondent, le type de retour et à quoi il correspond, si la fonction renvoie des exceptions et ce dans quels cas, une description rapide de ce que fait la fonction).


Autres :
  • indentation de 8 espaces, histoire que tout le monde est la même ; si vous utilisez Vim (qui est génial pour coder, c'est presque un IDE) vous pouvez visualiser et coder avec une indentation de 4, mais sauver le fichier avec une indentation de 8 en faisant ':set softtabstop=4' quand vous ouvrez un fichier.
  • les accolades ouvrantes sont sur la ligne après la déclaration de fonction (ou la déclaration de tableau) et indenté de la même manière que le nom de la focntion ; idem pour le if


Back to top
Jules
Développeurs

Offline

Joined: 02 Feb 2013
Posts: 384
Point(s): 3
Moyenne de points: 0.01

PostPosted: Mon 15 Jul - 12:12 (2013)    Post subject: Conventions Reply with quote

j'ai pas grand chose contre, mais le coup de mettre des "p_" pour les paramètres, c'est vraiment nécessaire ?

Et pour les attributs, c'est pas plus logique de leur laissé un nom "normal" et d'imposer la notation "_blablabla" pour les variables ?


Ps: si on se mettait tous d'accord sur l'IDE à utiliser, ça serait plus pratique non ?
_________________
Hey ! Tu sais quoi ?
. . .

T'as perdu !! Smile


Back to top
Pierre Moreau
Développeurs

Offline

Joined: 01 Feb 2013
Posts: 534
Point(s): 0
Moyenne de points: 0.00

PostPosted: Mon 15 Jul - 13:46 (2013)    Post subject: Conventions Reply with quote

Ce n'est pas nécessaire, mais je trouve plus pratique de pouvoir faire la différence dans le code entre les variables locales et les paramètres.
C'est quand même plus pratique d'avoir un style à part pour les attributs histoire de pouvoir les différencier du reste tout de suite. Ou alors, tu as un style pour les paramètres et un pour les variables locales.

Le problème pour le C++ au niveau de l'IDE, c'est qu'il y en a plein, et qu'il n'y a pas d'IDE dominant (si on exclu Visual Studio parce qu'on développe sous Linux, au moins pour certains). De plus, avoir un IDE unique ne règle en rien le fait d'avoir les mêmes paramètres si on laisse la possibilité aux personnes de tweaker les paramètres, et ce serait stupide de l'interdire.


Back to top
Raphaël
Développeurs

Offline

Joined: 04 Feb 2013
Posts: 81
Masculin
Point(s): 2
Moyenne de points: 0.02

PostPosted: Mon 15 Jul - 23:27 (2013)    Post subject: Conventions Reply with quote

+1 pour jules

Back to top
Skype
Pierre Moreau
Développeurs

Offline

Joined: 01 Feb 2013
Posts: 534
Point(s): 0
Moyenne de points: 0.00

PostPosted: Mon 15 Jul - 23:55 (2013)    Post subject: Conventions Reply with quote

J'ai trouvé un site où ils recensent les conventions recommandées en C++.

Back to top
Pierre Moreau
Développeurs

Offline

Joined: 01 Feb 2013
Posts: 534
Point(s): 0
Moyenne de points: 0.00

PostPosted: Thu 18 Jul - 10:17 (2013)    Post subject: Conventions Reply with quote

J'ai trouvé pire que moi ! Des gens qui préfixent toutes leurs variables suivant le type, la portée :
  • aName pour les arguments
  • sName pour les statics
  • mName pour les attributs
  • iName pour les itérateurs
  • ...

C'est peut-être un peu extrème, mais si vous voulez suivre un principe du style, je veux bien suivre.


Au final, ça ne me gène pas trop si on ne préfixe pas les arguments des fonctions, ou les variables locales. Par contre, pour les attibuts, si.


Back to top
Contenu Sponsorisé






PostPosted: Today at 08:10 (2018)    Post subject: Conventions

Back to top
Display posts from previous:   
This forum is locked: you cannot post, reply to, or edit topics.   This topic is locked: you cannot edit posts or make replies.    Wall of Deads - Game development team Forum Index -> Archives All times are GMT + 2 Hours
Page 1 of 1

 
Jump to:  

Index | Make a forum | Free support forum | Free forums directory | Report a violation | Conditions générales d'utilisation
Powered by phpBB © 2001, 2005 phpBB Group