[LCP] documentation Othello

Voir le sujet précédent Voir le sujet suivant Aller en bas

resolu [LCP] documentation Othello

Message  I.AM.BACK le Mer 07 Déc 2011, 16:23

Bonjour,
Je suis un peu confus en ce qui concerne la doc pour les fonctions d'affichage...
Etant donnée que toutes mes fonctions concernant la "view" sont utilisées dans une seule fonction englobante, je me demandais si c'était necessaire de fournir la documentation pour toutes ces mini-fonctions que j'ai créée juste pour rendre le code plus lisible ? Parce que ces fonctions sont à mes yeux comme des méthodes privées d'une classe, et tout ce qui est privé ne doit pas apparaître dans la doc non?
J'hésite donc à créer une classe JouerOthello avec seulement une méthode public ou bien de ne pas documenter du tout la partie "view"..


Dernière édition par I.AM.BACK le Mer 07 Déc 2011, 20:22, édité 1 fois

I.AM.BACK

Nombre de messages : 56
Age : 25
Prénom : Victor
Statut : étudiant indu 2ème année
Localisation : http://en.wikipedia.org/wiki/Armenia
Date d'inscription : 21/07/2011

Revenir en haut Aller en bas

resolu Re: [LCP] documentation Othello

Message  nvs le Mer 07 Déc 2011, 17:41

I.AM.BACK a écrit:Etant donnée que toutes mes fonctions concernant la "view" sont utilisées dans une seule fonction englobante, je me demandais si c'était necessaire de fournir la documentation pour toutes ces mini-fonctions que j'ai créée juste pour rendre le code plus lisible ? Parce que ces fonctions sont à mes yeux comme des méthodes privées d'une classe, et tout ce qui est privé ne doit pas apparaître dans la doc non?
il me semble avoir expliqué au cours de c un moyen pour limiter la possibilité d'utilisation d'une fonction au fichier source où elle est définie. cela marche toujours en c++, bien qu'on conseille de plutôt utiliser un espace de nom anonyme pour arriver au même résultat Smile





alien

_________________

nvs

Nombre de messages : 5238
Age : 44
Prénom : Nicolas
Statut : prof
Localisation : bxl
Date d'inscription : 24/11/2005

http://nvansteenkiste.googlepages.com

Revenir en haut Aller en bas

resolu Re: [LCP] documentation Othello

Message  I.AM.BACK le Mer 07 Déc 2011, 18:57

J'ai l'impression qu'à chaque fois que je loupe une séance, c'était LA séance qu'il fallait absolument pas louper Rolling Eyes
Merci pour vos liens, je pense que l'espace de nom anonyme correspond exactement à ce que je cherchais !

I.AM.BACK

Nombre de messages : 56
Age : 25
Prénom : Victor
Statut : étudiant indu 2ème année
Localisation : http://en.wikipedia.org/wiki/Armenia
Date d'inscription : 21/07/2011

Revenir en haut Aller en bas

resolu Re: [LCP] documentation Othello

Message  nvs le Mer 07 Déc 2011, 19:59

et, tu l'auras compris, les fonctions de l'espace de nom anonyme ne faisant pas partie de l'interface publique d'une bibliothèque logicielle, elles ne doivent pas être documentées comme ce qui est public Smile

remarque que je n'ai pas -- ou pas encore ? -- parlé de l'espace de nom sans nom au cours.












pig

_________________

nvs

Nombre de messages : 5238
Age : 44
Prénom : Nicolas
Statut : prof
Localisation : bxl
Date d'inscription : 24/11/2005

http://nvansteenkiste.googlepages.com

Revenir en haut Aller en bas

resolu Re: [LCP] documentation Othello

Message  Contenu sponsorisé Aujourd'hui à 07:16


Contenu sponsorisé


Revenir en haut Aller en bas

Voir le sujet précédent Voir le sujet suivant Revenir en haut


 
Permission de ce forum:
Vous ne pouvez pas répondre aux sujets dans ce forum