Niidhogg
Messages postés42Date d'inscriptiondimanche 8 février 2009StatutMembreDernière intervention11 octobre 20151 10 févr. 2012 à 14:42
Ok, merci beaucoup pour tes conseilles, je comprend ce que tu veut dire maintenant ;)
cs_Julien39
Messages postés6414Date d'inscriptionmardi 8 mars 2005StatutModérateurDernière intervention29 juillet 2020371 8 févr. 2012 à 19:02
Oui, tu l'as fait à certains endroits, mais tu ne l'as pas fait entièrement (pas de cadre de documentation correct au dessus de la classe ni des paramètres et certains blocs ne présentent pas les informations auxquelles on s'attend)
A ta place, j'aurais découpé le code en plus de petites fonctions et à la place des commentaires faits avec // j'aurais utilisé la javadoc au dessus des fonctions plus modulaires. Tu aurais eu plus de facilités pour faire des tests unitaires.
D'ailleurs, // est utilisé pour bloquer du code lors de la conception de ton projet et /* */ (avec une seule étoile, ce n'est pas de la javadoc) est utilisé pour documenter ton code.
Mais bon, ce que tu as fait est vraiment bien, si toutes les sources étaient aussi bien documentées que la tienne, ce serait vraiment bien.
Je t'avais parlé de la doc pour donner des pistes d'amélioration, j'essaye toujours d'en mettre dans les commentaires. Mais bon, ce que tu as fait est très bien.
Niidhogg
Messages postés42Date d'inscriptiondimanche 8 février 2009StatutMembreDernière intervention11 octobre 20151 8 févr. 2012 à 17:03
Il me semble pourtant m'en être servit, comme dans Food.java:
/**
* Bouger l'objectif
* @param posX position horizontal de l'objectif
* @param posY position vertical de l'objectif
*/
public void moveIt(int posX, int posY)
{...
Non ?
cs_Julien39
Messages postés6414Date d'inscriptionmardi 8 mars 2005StatutModérateurDernière intervention29 juillet 2020371 8 févr. 2012 à 10:52
javadoc est un outils initialement développer par sun pour générer de la documentation au format html à partir d'un code java. Cet outils est dans le jdk.
Pour cela, il faut que tu documentes ton code d'une manière précise, en utilisant les /** */, tu peux utiliser un certain nombres de mots clés @param, @return qui seront reconnus par le programme de lecture de ton code.
Niidhogg
Messages postés42Date d'inscriptiondimanche 8 février 2009StatutMembreDernière intervention11 octobre 20151 8 févr. 2012 à 10:03
Merci beaucoup pour ta réponse. Effectivement la partie visuel je n'y est pas passé beaucoup de temps, elle me paraissais moins importante.
J'aurais néanmoins une question, qu'entend tu exactement par javadoc ?
cs_Julien39
Messages postés6414Date d'inscriptionmardi 8 mars 2005StatutModérateurDernière intervention29 juillet 2020371 8 févr. 2012 à 08:16
Bonjour,
Ce qui est vraiment bien dans ta source c'est que tu as fait une vraie conception objet. Il existe plusieurs jeux de ce type sur ce site mais aucun n'a une conception aussi propre.
Le résultat visuel n'est pas top par contre, mais il reste fonctionnel. Tu as fait l'effort de documenter ton code et les commentaires ajoutés sont bons, je te conseillerais néanmoins d'utiliser la javadoc, si tu ne sais pas comment l'écrire, le site du zero a un très bon tuto.
31 déc. 2014 à 16:14
20 avril 2014 à 19:16
10 févr. 2012 à 14:42
8 févr. 2012 à 19:02
A ta place, j'aurais découpé le code en plus de petites fonctions et à la place des commentaires faits avec // j'aurais utilisé la javadoc au dessus des fonctions plus modulaires. Tu aurais eu plus de facilités pour faire des tests unitaires.
D'ailleurs, // est utilisé pour bloquer du code lors de la conception de ton projet et /* */ (avec une seule étoile, ce n'est pas de la javadoc) est utilisé pour documenter ton code.
Mais bon, ce que tu as fait est vraiment bien, si toutes les sources étaient aussi bien documentées que la tienne, ce serait vraiment bien.
Je t'avais parlé de la doc pour donner des pistes d'amélioration, j'essaye toujours d'en mettre dans les commentaires. Mais bon, ce que tu as fait est très bien.
8 févr. 2012 à 17:03
/**
* Bouger l'objectif
* @param posX position horizontal de l'objectif
* @param posY position vertical de l'objectif
*/
public void moveIt(int posX, int posY)
{...
Non ?
8 févr. 2012 à 10:52
Pour cela, il faut que tu documentes ton code d'une manière précise, en utilisant les /** */, tu peux utiliser un certain nombres de mots clés @param, @return qui seront reconnus par le programme de lecture de ton code.
Je te conseil de lire ceci : http://www.siteduzero.com/tutoriel-3-35079-presentation-de-la-javadoc.html#ss_part_1
8 févr. 2012 à 10:03
J'aurais néanmoins une question, qu'entend tu exactement par javadoc ?
8 févr. 2012 à 08:16
Ce qui est vraiment bien dans ta source c'est que tu as fait une vraie conception objet. Il existe plusieurs jeux de ce type sur ce site mais aucun n'a une conception aussi propre.
Le résultat visuel n'est pas top par contre, mais il reste fonctionnel. Tu as fait l'effort de documenter ton code et les commentaires ajoutés sont bons, je te conseillerais néanmoins d'utiliser la javadoc, si tu ne sais pas comment l'écrire, le site du zero a un très bon tuto.
Très bonne source quand même