Каким должно быть описание этого метода?

Question

OK этот метод считывает указатель, проверяет, что пути к файлу в порядке, а затем передает каждый файл методу и обновляет объект Map. Но как я могу объяснить это для java-документа. Я хочу создать java-документ и как мне объяснить этот метод для целей документации. Скажите, пожалуйста, если вы можете помочь мне с этим примером, я могу работать для всего моего проекта. спасибо:

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

Ваш метод не делает то, что вы сказали в своем первом предложении (не проверяет пути к файлам, и выбрасывает результат GetMap() далеко), но нет ничего неправильно с помещением такого предложения в Джавадока.

Answer 2

Есть некоторые проблемы с кодом:

• break заявление будет давать ошибку компиляции, я думаю. Это должно быть return.

• Плохой стиль, чтобы назвать поле с большой буквы в качестве первого символа. Если Dir и Map - имена полей, они должны быть dir и map соответственно.

• Оператор Map = getMap(file); собирается повторно заменить на Map поле, и при выходе из цикла, то поле будет ссылаться на объект, возвращаемый последней getmap вызова. Возможно, это неправильно.

• И наконец, измените заявление file следующим образом. (Там нет необходимости создавать новый объект File ... потому что getAbsoluteFile() reurns File)

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