Wie soll die Beschreibung für diese Methode aussehen?

Question

OK diese Methode liest einen Dirctor, verifiziert, dass die Dateipfade in Ordnung sind und gibt dann jede Datei an eine Methode weiter und aktualisiert ein Map-Objekt. Aber wie kann ich dies für Java Doc zu erklären. Ich möchte ein Java-Dokument erstellen und wie soll ich diese Methode für den Zweck der Dokumentation erklären. Bitte sagen Sie mir, wenn Sie mir mit diesem Beispiel helfen können, kann ich für mein ganzes Projekt arbeiten. danke:

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

Ihre Methode, was Sie in Ihrem ersten Satz sagte nicht tun, aber es gibt nichts (keine Dateipfade und wirft das Ergebnis getMap() entfernt nicht verifizieren) falsch damit, diese Art von Satz im Javadoc zu setzen.

Answer 2

Es gibt einige Probleme mit Ihrem Code:

• Die break Anweisung wird ein Übersetzungsfehler geben, denke ich. Es sollte ein return sein.

• Es ist ein schlechter Stil, ein Feld mit einem Großbuchstaben als erstes Zeichen zu benennen. Wenn Dir und Map Feldnamen sind, sollten sie dir bzw. map sein.

• Die Aussage Map = getMap(file); wird wiederholt das Map Feld ersetzen, und wenn Sie die Schleife verlassen, wird das Feld auf das Objekt durch den letzten getmap Aufruf zurück beziehen. Das ist wahrscheinlich falsch.

• Schließlich ändern Sie die file Deklaration wie folgt. (Es gibt keine Notwendigkeit, ein neues File-Objekt zu erstellen ... weil getAbsoluteFile() reurns einen File)

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