Не удается запустить класс Doclet, предоставленный Oracle - PullRequest
Новая
       44

Не удается запустить класс Doclet, предоставленный Oracle

2 голосов
/ 25 марта 2019

Я хочу поэкспериментировать с Doclets ( JDK 9 ), поэтому я попробовал все, шаг за шагом, приведенный в этой ссылке . Я не добавил ничего особенного в классе Example. Это именно то, что дает Oracle (я только что добавил импорт).

Oracle дает команду: 

javadoc -doclet Example \
       -overviewfile overview.html \
       -sourcepath source-location \
       source-location/Example.java

Теперь, когда я запускаю данную команду javadoc , я получаю следующую ошибку:

javadoc: ошибка - не удается найти класс доклета Пример

Я попробовал некоторые варианты команды, так как она кажется проблемой для директоров, но все мои попытки провалились.

Я помещаю Example.java в папку рабочего стола: C:\Users\George\Desktop\

Итак, в моей командной строке я cd C:\Users\George\Desktop\. Затем javac Example.java (на случай, если он захочет скомпилироваться).

А потом я пробую все следующие команды, получая ту же ошибку. 

javadoc -doclet Example -overviewfile overview.html -sourcepath ./ ./Example.java

. 

javadoc -doclet Example -overviewfile overview.html -sourcepath "C:\Users\George\Desktop\" "C:\Users\George\Desktop\Example.java"

(+ без кавычек)

javadoc -doclet Example -overviewfile overview.html"C:\Users\George\Desktop\Example.java"

Я попробовал несколько других вещей, найденных в SO, но опять же, ничего не работает. Что мне не хватает? Разве данный пример не должен работать?

Пример класса (если вы видите что-то, чего я не вижу): 

public class Example implements Doclet {
    Reporter reporter;
    String overviewFile;

    public static void main(String[] args) {
    }

    public Example() {
        // TODO Auto-generated constructor stub
    }

    @Override
    public void init(Locale locale, Reporter reporter) {
        reporter.print(Kind.NOTE, "Doclet using locale: " + locale);
        this.reporter = reporter;
    }

    public void printElement(DocTrees trees, Element e) {
        DocCommentTree docCommentTree = trees.getDocCommentTree(e);
        if (docCommentTree != null) {
            System.out.println("Element (" + e.getKind() + ": " + e + ") has the following comments:");
            System.out.println("Entire body: " + docCommentTree.getFullBody());
            System.out.println("Block tags: " + docCommentTree.getBlockTags());
        }
    }

    @Override
    public String getName() {
        return "Example";
    }

    @Override
    public Set<? extends Option> getSupportedOptions() {
        Option[] options = { new Option() {
            private final List<String> someOption = Arrays.asList("-overviewfile", "--overview-file", "-o");

            @Override
            public int getArgumentCount() {
                return 1;
            }

            @Override
            public String getDescription() {
                return "an option with aliases";
            }

            @Override
            public Option.Kind getKind() {
                return Option.Kind.STANDARD;
            }

            @Override
            public List<String> getNames() {
                return someOption;
            }

            @Override
            public String getParameters() {
                return "file";
            }

            @Override
            public boolean process(String opt, List<String> arguments) {
                overviewFile = arguments.get(0);
                return true;
            }
        } };
        return new HashSet<>(Arrays.asList(options));
    }

    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latest();
    }

    @Override
    public boolean run(DocletEnvironment docEnv) {
        reporter.print(Kind.NOTE, "overviewfile: " + overviewFile);
        // get the DocTrees utility class to access document comments
        DocTrees docTrees = docEnv.getDocTrees();

        // location of an element in the same directory as overview.html
        try {
            Element e = ElementFilter.typesIn(docEnv.getSpecifiedElements()).iterator().next();
            DocCommentTree docCommentTree = docTrees.getDocCommentTree(e, overviewFile);
            if (docCommentTree != null) {
                System.out.println("Overview html: " + docCommentTree.getFullBody());
            }
        } catch (IOException missing) {
            reporter.print(Kind.ERROR, "No overview.html found.");
        }

        for (TypeElement t : ElementFilter.typesIn(docEnv.getIncludedElements())) {
            System.out.println(t.getKind() + ":" + t);
            for (javax.lang.model.element.Element e : t.getEnclosedElements()) {
                printElement(docTrees, e);
            }
        }
        return true;
    }
}

1 Ответ

1 голос
/ 25 марта 2019

Запуск javadoc --help открывает следующую опцию: 

-docletpath <path>
              Specify where to find doclet class files

Используйте эту опцию, и она должна работать нормально (при условии, что вы скомпилировали класс Example и он действительно находится в каталоге, переданном в качестве аргумента этомуопция).

...