Bon voila j´ai commencé un jeu, mais le gros problème comment bien documenter mon code(cella est tres important a ceux niveau), à quel endroit, avec quel type de commentaire, ect...

P.S: J´utilise le c++

Doxygen ! !

=> commentaires inline, donc maintenabilité accrue, facilité pour générer des docs externes facilement consultables ( i.e. html compilé)

Sinon, comment commenter ? Une grossiere approche peut etre la suivante : pour chaque classe, qq lignes pour expliquer à quoi elle, comment s´en servir, pour chaque méthode, à quoi elle sert, ce qu´elle prend en parametre, ce qu´elle retourne en sortie, la manière dont elle procede ( faire reference à des algos communs, genre " dérivé de bubble-sort", ou " moindres carrés recursifs", etc. enfin, des choses concises et connues, pour savoir en un clin d´oeil comment grossierement la méthode fonctionne), eventuellement la complexité ( pour les choses exclusivement algorithmique, et surtout des précautions d´emploi ( genre, " ne pas utiliser, si . ..." ou " verifier que le resultat...", pour eviter de tomber dans des failles des algos mis en place)
Si une partie de code contient des finesses, des choses inattendue, ou des zones particulièrement compliquées, mettre un peu de commentaire dans le corps meme des méthodes, sinon EVITER ( ça allourdit pour rien en général)
enfin, ne commenter que là ou c´est utile : non, pas la peine d´expliquer en 50 lignes ce que fait ce getter moisi...
Voilà voilà, qq conseils qui peuvent aider. Egalement, commenter en anglais ( l´habitude est bonne, pour quand tu bosses dans une boite, meme française), et respecter des conventions de nommage reconnues. Avec ça, on arrive à des choses assez claires :D

Pour les commentaires, tu fait a ta sauce.

Tu a le choix entre " //" qui te commente tout ce qu´il y a apres jusqu´au prochain retour a la ligne, et " /*" qui te commente tout jusqu´au prochain " */"
Mais sa tu le sais deja. Apres, c´est l´utilisation de ceux ci qui est important

Ma fasson de commenter : un entete de fichier, avec descriptif de ce qu´il fait, les classes qui sont dedant...

Descriptif avant chaque declaration de class, avec chaque fontion, pour comprendre a quoi elle sert et une peu comment elle marche.

A l´interieur des fonctions, je prefere mettre 2-3 petits commentaires expliquant mon algo que de commenter les lignes les une apres les autre. Je trouve sa moins fouillis.

Sinon, durant un stage, on m´avais demandé de commenter mon code avec doxygen. C´est simpa, sa fait une jolie doc, mais je trouve la syntaxe pas jolie.

Je sais que durant tout les projet que j´ai fait a plusieur, personne ne commentait de la meme façon, c´etait pas super ordoné. Chacun a ses petites habitudes. En industrie, je pense qu´ils doivent avoir tous une certaine norme de codage, dont une certaine fasson de commenter. Il faudrait que des professionel repondent, comme Lapintade

Je commente de la façon que lapintade a décrite :
commentaire en début de fonction/methode pour dire ce qu´elle fait, avant les structures ( mais bon, jfais du C donc je mets jamais de classes) et après à la moindre finesse, petit commentaire.

Chacun a ses facon commenter ( meme dans l´industrie). Chacun a ses petites notations et ses petites manies.

Le plus important, c´est que le code soit commenté ! !!! Mine de rien, je connais beaucoup de programmeurs qui commentent rien du tout. Et c´est chiant pour eux ainsi que pour les autres.

Au niveau des commentaires, Je mets un commentaire au debut de chaque bloque important qui a besoin d´etre commenté, avec / / --
Pour les petits commentaires, je les ajoutent en fin de ligne.

Pour voir mes regles de code sur DNA, c´est la :
http://www.gosg.org/viewtewtopic.php?topic=348&forum=31
Ca donne une idée.

Mais bon chacun a ses propres notations, faut faire comme on aime.

Un exemple de DNA :
http://walljv.free.fr/index.php?to=view&id=74

Pour le coup, je fait comme lapintade :
http://walljv.free.fr/index.php?to=view&id=75

Les commentaires sont en francais, mais d´habitude ils sont en anglais ( etude en ecosse oblige)

( si vous avez des remarques sur le code, dites le moi , meme si c´est un truc fait hier soir vers 1H du matin. J´essaye de faire un gestionaire de menu le plus flexible possible en utilisant le polymorphisme )

Merci avous je regaderais ça demain et encore

J´aime bien ton code Ruffi, il est aeré et bien commenté. Je trouve juste les entete un peu chargées ( beaucoup de texte pour finalement trés peu d´informations interressantes). C´est certainement du copié/collé.

Merci

C´est vrai qu´ici mes truc de bug et de todo ne sont pas d´une grande utilité, et qu´il n´y a pas grand chose. J´aurai du mettre un code avec des fonctions ayant plein de parametres et des explication plus longues.

Je vais peut etre passer à une version avec les entete contenant moins de chose ( indication des todo et des bug uniquement si besoin), sa evitera le surplus d´information inutiles.

Sinon, c´est bien du " Ctrl+C"/"Ctrl+V"

j´ai mis une partie allégé de l´en tête de ma librairie qui est assez commenté. C´est pas du code, mais c´est aussi des trucs à commentez.
Peut-être même encore plus car c´est le seul truc que voit l´utilisateur de ma librairie ( come code je veut dire, il y a quand même un mode d´emploi plus propre).

http://walljv.free.fr/index.php?to=view&id=76

C´est bien commenté. Sans savoir ce que ca fait, on a deja pas mal d´infos.
Dommae qu´il y ait autant de namespace ( je deteste les namespace )

Bon voila j´ai entendu dire(ou lu) que il etait tres utile de commenter chaque condition(if). Est ce vraie?

D´un maniere generale, c´est utile de commenter les endroit qui ne sont pas comprehensible immediatement.

Si t´ecrit.

If ( PersoToucheLeMur == true )

et que tu mets en commentaire : " Test le le perso touche le mur". Je trouve pas ca interressant.

Donc je pense pas que ce soit utile de dire il faut commenter systematiquement tel ou tel type d´operations.

Par contre un truc utile, c´est de commenter le crochet fermants.

Par exemple

if ( PersoMort)
{
. ..Bla bla
. ..if(PersoEmpoisonne)
. ..{
. ..Blabla
. ..} / / If perso empoisonné.
} / / IF perso mort

Sur des gros morceaux avec pas mal d´imbrication, ca peut devenir utile de connaitre a quoi corresponde les fin de bloc.

Merci beaucoup.