Commenter un programme

Commenter un programme - Java - Programmation

Marsh Posté le 11-11-2012 à 03:00:18    

Bonjour  
Pourrais t'on SVP m'aider via des commentaires bien explicites et expliqués étapes par étapes pour bien comprendre ce programme: pour indice c'est un algo qui partant d'une ville de départ (paris) doit faire le tour de 6 villes pour revenir à paris, donc il y'a un total de 7 villes ^^ et il doit toujours trouver la distance la plus proche choisir cette ville et y'a pas possibilité de passer dans une ville 2 fois.
Je precise qu'il y'a 2 fichiers joints: respectivement Algo.java et ville.java.
je vous remercie d'avance :)
 

Code :
  1. import java.util.HashMap;
  2. import java.util.Map.Entry;
  4. public class Algo{
  6. private HashMap<String,Ville> villes;
  8. public Algo(){
  10.  villes = new HashMap<String,Ville>();
  12.  Ville nice = new Ville("Nice" );
  13.  nice.addDistance("Angers",999);
  14.  nice.addDistance("Bordeaux",844);
  15.  nice.addDistance("Clermond",620);
  16.  nice.addDistance("Paris",950);
  17.  nice.addDistance("Strasbourg",842);
  18.  nice.addDistance("Montpellier",345);
  19.  villes.put(nice.getNom(),nice);
  21.  Ville angers = new Ville("Angers" );
  22.  angers.addDistance("Nice",999);
  23.  angers.addDistance("Bordeaux",335);
  24.  angers.addDistance("Clermond",402);
  25.  angers.addDistance("Paris",303);
  26.  angers.addDistance("Strasbourg",742);
  27.  angers.addDistance("Montpellier",692);
  28.  villes.put(angers.getNom(),angers);
  30.  Ville bordeaux = new Ville("Bordeaux" );
  31.  bordeaux.addDistance("Nice",844);
  32.  bordeaux.addDistance("Angers",335);
  33.  bordeaux.addDistance("Clermond",369);
  34.  bordeaux.addDistance("Paris",561);
  35.  bordeaux.addDistance("Strasbourg",958);
  36.  bordeaux.addDistance("Montpellier",499);
  37.  villes.put(bordeaux.getNom(),bordeaux);
  39.  Ville clermond = new Ville("Clermond" );
  40.  clermond.addDistance("Nice",620);
  41.  clermond.addDistance("Angers",102);
  42.  clermond.addDistance("Bordeaux",369);
  43.  clermond.addDistance("Paris",425);
  44.  clermond.addDistance("Strasbourg",574);
  45.  clermond.addDistance("Montpellier",367);
  46.  villes.put(clermond.getNom(), clermond);
  48.  Ville paris = new Ville("Paris" );
  49.  paris.addDistance("Nice",950);
  50.  paris.addDistance("Angers",303);
  51.  paris.addDistance("Bordeaux",561);
  52.  paris.addDistance("Clermond",425);
  53.  paris.addDistance("Strasbourg",448);
  54.  paris.addDistance("Montpellier",763);
  55.  villes.put(paris.getNom(),paris);
  57.  Ville strasbourg = new Ville("Strasbourg" );
  58.  strasbourg.addDistance("Nice",842);
  59.  strasbourg.addDistance("Angers",742);
  60.  strasbourg.addDistance("Bordeaux",958);
  61.  strasbourg.addDistance("Clermond",574);
  62.  strasbourg.addDistance("Paris",448);
  63.  strasbourg.addDistance("Montpellier",727);
  64.  villes.put(strasbourg.getNom(),strasbourg);
  66.  Ville montpellier = new Ville("Montpellier" );
  67.  montpellier.addDistance("Nice",345);
  68.  montpellier.addDistance("Angers",692);
  69.  montpellier.addDistance("Bordeaux",499);
  70.  montpellier.addDistance("Clermond",367);
  71.  montpellier.addDistance("Paris",763);
  72.  montpellier.addDistance("Strasbourg",727);
  73.  villes.put(montpellier.getNom(),montpellier);
  74. }
  76. public HashMap<String,Ville> getVilles(){
  77.  return this.villes;
  78. }
  80. public int displayTravelingSalesmanV1(String nom, String arrive, HashMap<String,Ville> villesRestantes){
  82.  int min = Integer.MAX_VALUE;
  83.  String nextVille = null;
  84.  int distance;
  86.  for(Entry<String, Ville> entry : villesRestantes.entrySet()) {
  87.      Ville value = entry.getValue();
  88.      distance = value.getDistanceTo(nom);
  89.   if(distance > 0 && distance < min && (!arrive.equals(value.getNom()) || villesRestantes.size() <= 1)){
  90.    min = distance;
  91.    nextVille = value.getNom();
  92.   }
  93.  }
  96.  if(nextVille != null){
  97.   villesRestantes.remove(nextVille);
  98.   System.out.println(nom + " -> " + nextVille + " = " + min + "km" );
  99.   return min + displayTravelingSalesmanV1(nextVille,arrive,villesRestantes);
  100.  }
  101.  return 0;
  102. }
  104. int[][] suites = new int[7][7];
  106. public int displayTravelingSalesmanV2(int i, int j){
  109. }
  111. public static void main(String[] args){
  112.  Algo algo = new Algo();
  113.  int distanceTotale = algo.displayTravelingSalesmanV1("Paris","Paris", algo.getVilles());
  115.  System.out.println("Distance Total parcourue: " + distanceTotale + "km" );
  116. }
  118. }


 
 
 

Code :
  1. import java.util.HashMap;
  3. public class Ville{
  5. private HashMap<String,Integer> distances;
  6. private String nom;
  8. public Ville(String nom){
  9.  this.nom = nom;
  10.  this.distances = new HashMap<String,Integer>();
  11. }
  13. public String getNom(){
  14.  return this.nom;
  15. }
  17. public void addDistance(String ville,Integer distance){
  18.  this.distances.put(ville,distance);
  19. }
  21. public Integer getDistanceTo(String ville){
  23.  if(this.distances.containsKey(ville)){
  24.   return this.distances.get(ville);
  25.  }
  27.  return -1;
  28. }
  32. }

Reply

Marsh Posté le 11-11-2012 à 03:00:18   

Reply

Marsh Posté le 11-11-2012 à 14:23:56    

Le mieux c'est de faire les commentaires toi même pour voir si t'as compris, et après, tu postes pour qu'on les check.

Message cité 1 fois

---------------
"Coucou petit perruche, c'est moi l'élan derrière toi !"
Reply

Marsh Posté le 11-11-2012 à 16:26:10    

reelooz10 a écrit :

Le mieux c'est de faire les commentaires toi même pour voir si t'as compris, et après, tu postes pour qu'on les check.


Code :
  1. // implementation de l'interface Map par l'utilisation de table hachee (HashMap qui sert à retirer retirer les iterations à chaque ville parcourue
  2. //definition ville de depart (paris) et ville d'arrivee en parametre in the main
  3. import java.util.HashSet;
  4. import java.util.HashMap;
  5. import java.util.Map.Entry;
  8. public class Heuristique{
  10. public static void main(String[] args)
  11. {
  12.  Heuristique heuristique = new Heuristique();
  13.  int Totale = heuristique.displayVoyageV1("Paris","Paris", heuristique.getVilles());
  15.   System.out.println("La distance parcourue est: " + Totale + "kms" );
  16. }
  18.      private HashMap<String, Ville> city;
  22.    //methodes pour saisie ville actuelle, calcul/recherche ville la plus proche, retour de la disttance et calcul de la prochaine ville jusqu'a faire le tour
  23.    //
  25. public HashMap<String,Ville> getVilles()
  26. {
  27.  return this.city;
  28. }
  30.      public int displayVoyageV1(String name, String arrive, HashMap<String,Ville> VilleNonParcourue)
  31. {
  33.   int portee;
  34.   int min = Integer.MAX_VALUE;
  35.   String prochaineVille = null;
  38.    for(Entry<String, Ville> entry : VilleNonParcourue.entrySet())
  39.     {
  40.      Ville value = entry.getValue();
  41.      portee = value.getPorteeTo(name);
  42.      if(portee > 0 && portee < min && (!arrive.equals(value.getName()) || VilleNonParcourue.size() <= 1))
  43.        {
  44.         min = portee;
  45.         prochaineVille = value.getName();
  46.        }
  47.     }
  50.        if(prochaineVille != null)
  51.         {
  52.          VilleNonParcourue.remove(prochaineVille);
  53.          System.out.println(name + " -> " + prochaineVille + " = " + min + "km" );
  54.          return min + displayVoyageV1(prochaineVille,arrive,VilleNonParcourue);
  55.         }
  56.         return 0;
  57. }
  59. // declaration matrice diagonale
  61. int[][] matrice = new int[7][7];
  63. /*public int displayVoyageV2(int i, int j)
  64. {
  67. }*/
  69.     /*instanciation des villes et initialisation de la matrice distance sauf pour la ville en question
  70. implementation des methodes put et get pour les differentes distances */
  73.    public Heuristique()
  74.       {
  77.              city = new HashMap<String,Ville>();
  79.     Ville angers = new Ville("Angers" );
  81.     angers.addPortee("Bordeaux",335);
  82.     angers.addPortee("Clermond",402);
  83.     angers.addPortee("Montpellier",692);
  84.     angers.addPortee("Nice",999);
  85.     angers.addPortee("Paris",303);
  86.     angers.addPortee("Strasbourg",742);
  88.     city.put(angers.getName(),angers);
  91.      Ville bordeaux = new Ville("Bordeaux" );
  92.      bordeaux.addPortee("Angers",335);
  93.      bordeaux.addPortee("Clermond",369);
  94.      bordeaux.addPortee("Montpellier",499);
  95.      bordeaux.addPortee("Nice",844);
  96.      bordeaux.addPortee("Paris",561);
  97.      bordeaux.addPortee("Strasbourg",958);
  98.      city.put(bordeaux.getName(),bordeaux);
  101.       Ville clermond = new Ville("Clermond" );
  102.       clermond.addPortee("Angers",402);
  103.       clermond.addPortee("Bordeaux",369);
  104.       clermond.addPortee("Montpellier",367);
  105.       clermond.addPortee("Nice",620);
  106.       clermond.addPortee("Paris",425);
  107.       clermond.addPortee("Strasbourg",574);
  108.       city.put(clermond.getName(), clermond);
  110.        Ville montpellier = new Ville("Montpellier" );
  111.        montpellier.addPortee("Angers",692);
  112.        montpellier.addPortee("Bordeaux",499);
  113.        montpellier.addPortee("Clermond",367);
  114.        montpellier.addPortee("Nice",345);
  115.        montpellier.addPortee("Paris",763);
  116.        montpellier.addPortee("Strasbourg",727);
  117.        city.put(montpellier.getName(),montpellier);
  119.         Ville nice = new Ville("Nice" );
  120.         nice.addPortee("Angers",999);
  121.         nice.addPortee("Bordeaux",844);
  122.         nice.addPortee("Clermond",620);
  123.         nice.addPortee("Montpellier",345);
  124.         nice.addPortee("Paris",950);
  125.         nice.addPortee("Strasbourg",842);
  126.         city.put(nice.getName(),nice);
  129.          Ville paris = new Ville("Paris" );
  130.          paris.addPortee("Angers",303);
  131.          paris.addPortee("Bordeaux",561);
  132.          paris.addPortee("Clermond",425);
  133.          paris.addPortee("Montpellier",763);
  134.          paris.addPortee("Nice",950);
  135.          paris.addPortee("Strasbourg",448);
  136.          city.put(paris.getName(),paris);
  139.           Ville strasbourg = new Ville("Strasbourg" );
  140.           strasbourg.addPortee("Angers",742);
  141.           strasbourg.addPortee("Bordeaux",958);
  142.           strasbourg.addPortee("Clermond",574);
  143.           strasbourg.addPortee("Montpellier",727);
  144.           strasbourg.addPortee("Nice",842);
  145.           strasbourg.addPortee("Paris",448);
  146.           city.put(strasbourg.getName(),strasbourg);
  149. }
  155. }


 
 
 

Code :
  1. // classe Ville
  3. import java.util.HashSet;
  4. import java.util.HashMap;
  5. import java.util.Map.Entry;
  7. public class Ville
  8. {
  10. private HashMap<String,Integer> portees;
  11. private String name;
  14.     //mutateurs pour ajout des distances, determination de la cle des villes si elle existe, puis recherche nom ville sa distance dans HashMap et retour du nom.
  15.  public void addPortee(String ville,Integer portee)
  16.  {
  17.  this.portees.put(ville,portee);
  18.  }
  20.  public Integer getPorteeTo(String ville)
  21.       {
  23.         if(this.portees.containsKey(ville))
  24.          {
  25.           return this.portees.get(ville);
  26.          }
  28.                    return -1;
  29.       }
  31.   public Ville(String name)
  32.   {
  33.    this.name = name;
  34.    this.portees = new HashMap<String,Integer>();
  35.   }
  37.    public String getName()
  38.    {
  39.     return this.name;
  40.    }
  48. }

Reply

Marsh Posté le 11-11-2012 à 22:15:39    

Si tu veux faire un truc bien, au moins commente chaque boucle, chaque condition, ect... La ce que tu fais ne sert à rien pour "comprendre" le code.

Message cité 1 fois

---------------
"Coucou petit perruche, c'est moi l'élan derrière toi !"
Reply

Marsh Posté le 12-11-2012 à 03:24:13    

reelooz10 a écrit :

Si tu veux faire un truc bien, au moins commente chaque boucle, chaque condition, ect... La ce que tu fais ne sert à rien pour "comprendre" le code.


je crois que j'ai posté ce message juste pour ça, sinon je l'aurais fait moi même sans demander l'avis d'expert :D

Reply

Marsh Posté le 12-11-2012 à 09:07:20    

Essaye au moins. Si tu crois qu'on va faire le taff à ta place...


---------------
"Coucou petit perruche, c'est moi l'élan derrière toi !"
Reply

Marsh Posté le 12-11-2012 à 11:05:10    

Commenter le code c'est :

  • un commentaire par variable
  • un commentaire par méthode
  • un commentaire par boucle / condition / élément d'algo non trivial


Un bon commentaire se fait sur une ligne
 
Plus un cartouche en entête de chaque classe ou tu écrits sur le rôle de la classe,  
et peux écrire un peu de "littérature" sur l'utilité de la classe, ses limitations, les choix d'algos qui sont faits.
 
Tout cela est normé en javadoc  
cf par exemple http://simonandre.developpez.com/t [...] n-javadoc/
 
Tu as quelque choses à livrer à un client ou un devoir à remettre à un prof ?

Reply

Marsh Posté le 12-11-2012 à 11:23:15    

Je me dévoue par amour du beau code :-)
 

Code :
  1. import java.util.HashSet;
  2. import java.util.HashMap;
  3. import java.util.Map.Entry;
  5. /**
  6. * Classe ville.
  7. * Une ville a  un nom (String name)
  8. * et une portée (distance avec les autres villes) sous forme de la  Hashmap portee.
  9. * @author omzoway
  10. *
  11. */
  14. public class Ville
  15. {
  16. /** la portée sous forme de Hashmap*/
  17. private HashMap<String,Integer> portees;
  19. /** le nom de la ville */
  20. private String name;
  22. /**
  23.  *  Ajout d'une portée dans la Hashmap portees sous la clé ville
  24.  * @param ville la ville clé de la Hashmap
  25.  * @param portee la portée à ajouter à la ville
  26.  */
  27. public void addPortee(String ville,Integer portee)
  28. {
  29.  this.portees.put(ville,portee);
  30. }
  32. /**
  33.  * Getter de la portée d'une ville, récupérée dans la Hashmap portee
  34.  * @param ville la ville dont on cherche la portée
  35.  * @return la portée correspondant à la ville en param, -1 si clé ville inexistante
  36.  */
  37. public Integer getPorteeTo(String ville)
  38. {
  39.  if(this.portees.containsKey(ville))
  40.  {
  41.   //retourne la portee dans la map correspondant à la clé  
  42.   return this.portees.get(ville);
  43.  }
  44.  //si on est la c'est que la map n'a pas de valeur pour la clé ville, retourne la valeur -1 comme valeur par défaut
  45.  return -1;
  46. }
  48. /**
  49.  * Constructeur d'instance de Ville à un paramètre
  50.  * @param name le nom de la ville
  51.  */
  52. public Ville(String name)
  53. {
  54.  this.name = name;
  55.  this.portees = new HashMap<String,Integer>();
  56. }
  58. /**
  59.  * Getter du nom de la ville
  60.  * @return le nom de la ville
  61.  */
  62. public String getName()
  63. {
  64.  return this.name;
  65. }
  66. }

Message cité 1 fois
Message édité par willy le kid le 12-11-2012 à 17:53:06
Reply

Marsh Posté le 13-11-2012 à 07:42:42    

willy le kid a écrit :

Je me dévoue par amour du beau code :-)
 

Code :
  1. import java.util.HashSet;
  2. import java.util.HashMap;
  3. import java.util.Map.Entry;
  5. /**
  6. * Classe ville.
  7. * Une ville a  un nom (String name)
  8. * et une portée (distance avec les autres villes) sous forme de la  Hashmap portee.
  9. * @author omzoway
  10. *
  11. */
  14. public class Ville
  15. {
  16. /** la portée sous forme de Hashmap*/
  17. private HashMap<String,Integer> portees;
  19. /** le nom de la ville */
  20. private String name;
  22. /**
  23.  *  Ajout d'une portée dans la Hashmap portees sous la clé ville
  24.  * @param ville la ville clé de la Hashmap
  25.  * @param portee la portée à ajouter à la ville
  26.  */
  27. public void addPortee(String ville,Integer portee)
  28. {
  29.  this.portees.put(ville,portee);
  30. }
  32. /**
  33.  * Getter de la portée d'une ville, récupérée dans la Hashmap portee
  34.  * @param ville la ville dont on cherche la portée
  35.  * @return la portée correspondant à la ville en param, -1 si clé ville inexistante
  36.  */
  37. public Integer getPorteeTo(String ville)
  38. {
  39.  if(this.portees.containsKey(ville))
  40.  {
  41.   //retourne la portee dans la map correspondant à la clé  
  42.   return this.portees.get(ville);
  43.  }
  44.  //si on est la c'est que la map n'a pas de valeur pour la clé ville, retourne la valeur -1 comme valeur par défaut
  45.  return -1;
  46. }
  48. /**
  49.  * Constructeur d'instance de Ville à un paramètre
  50.  * @param name le nom de la ville
  51.  */
  52. public Ville(String name)
  53. {
  54.  this.name = name;
  55.  this.portees = new HashMap<String,Integer>();
  56. }
  58. /**
  59.  * Getter du nom de la ville
  60.  * @return le nom de la ville
  61.  */
  62. public String getName()
  63. {
  64.  return this.name;
  65. }
  66. }



 
 
bonjour, Merci merci, promis je lirai le javadoc, non non pas pour un client mais déjà rendu. et le Heuristique.java? il est plus beau non? lool

Reply

Marsh Posté le 09-12-2012 à 12:12:10    

ah, cette exo c'est sur les chemins eulériens non ? :) je me rappelle l'avoir fais dans ma jeunesse l'an dernier ^^ il faut que tu buches l'algorithme de Dijkstra pour comprendre.

Reply

Sujets relatifs:

Leave a Replay

Make sure you enter the(*)required information where indicate.HTML code is not allowed