该方法的描述应该是什么?

时间:2010-11-29 02:37:53

标签: java

确定此方法读取dirctor,验证文件路径是否正常,然后将每个文件传递给方法并更新Map对象。 但是我怎么能为java doc解释这个。我想创建一个java doc,我该如何解释这个方法用于文档目的。请告诉我,如果你可以帮助我这个例子,我可以为我的整个项目工作。谢谢你:

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);
    }

}

2 个答案:

答案 0 :(得分:2)

您的方法没有按照您的说法在您的第一句话中(不验证文件路径,并抛出getMap()的结果),但将这种句子放入Javadoc并没有错。< / p>

答案 1 :(得分:2)

您的代码存在一些问题:

  • 我认为break语句会出现编译错误。它应该是return

  • 使用大写字母作为第一个字符命名字段是不好的方式。如果DirMap是字段名称,则它们应分别为dirmap

  • 语句Map = getMap(file);将重复替换 Map字段,当您退出循环时,该字段将引用由该字段返回的对象上次getmap来电。这可能是错误的。

  • 最后,更改file声明,如下所示。 (无需创建新的File对象...因为getAbsoluteFile()重新生成File

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