Quelle devrait être la description de cette méthode?

Question

OK cette méthode lit un dirctor, vérifie que les chemins de fichier sont corrects, puis passe chaque fichier à une méthode et met à jour un objet Map. Mais comment puis-je expliquer cela pour java doc. Je veux créer un doc java et comment dois-je expliquer cette méthode à des fins de documentation. S'il vous plaît dites-moi, si vous pouvez m'aider avec cet exemple, je peux travailler pour l'ensemble de mon projet. merci

private void chckDir() { 
File[] files = Dir.listFiles(); 
    if (files == null) { 
     System.out.println("Error"); 
     break; 
    } 

    for (int i = 0; i < files.length; i++) { 
     File file = new File(files[i].getAbsoluteFile().toString()); 
        Map = getMap(file); 
    } 

}

Answer 1

Votre méthode ne fait pas ce que vous avez dit dans votre première phrase (ne vérifie pas les chemins de fichiers, et jette le résultat de getMap() loin), mais il n'y a rien mal à mettre ce genre de phrase dans le Javadoc.

Answer 2

Il y a quelques problèmes avec votre code:

• La déclaration break donnera une erreur de compilation, je pense. Ce devrait être un return.

• Il est mauvais de nommer un champ avec une lettre majuscule comme premier caractère. Si Dir et Map sont des noms de champs, ils doivent être respectivement dir et map.

• La déclaration Map = getMap(file); va à plusieurs reprises remplacer le champ Map, et lorsque vous quittez la boucle, le champ référence à l'objet retourné par le dernier appel getmap. C'est probablement faux.

• Enfin, modifiez la déclaration file comme suit. (Il n'y a pas besoin de créer un nouvel objet fichier ... parce que getAbsoluteFile() reurns un File)

  File file = files[i].getAbsoluteFile();