Как сгенерировать Javadoc из командной строки - PullRequest
55 голосов
/ 04 января 2011

Может кто-нибудь показать мне, как генерировать Javadoc из командной строки?

Мой проект содержит пакет com.test, и я хочу поместить сгенерированную документацию в файлы, расположенные в определенной папке, например: C:/javadoc/test.

Ответы [ 7 ]

43 голосов
/ 04 января 2011

Вы можете обратиться к документации javadoc 8

Я думаю, что вы смотрите на это что-то вроде:

javadoc -d C:\javadoc\test com.test
25 голосов
/ 17 июня 2013

Oracle предоставляет несколько простых примеров:

http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDJBGFC

Предполагается, что вы находитесь в ~ /, а исходное дерево Java находится в ./saxon_source/net, и вы хотите пройти через всеСеть с исходным деревом - это и каталог, и имя верхнего пакета.

mkdir saxon_docs
javadoc -d saxon_docs -sourcepath saxon_source -subpackages net
12 голосов
/ 26 апреля 2015

Допустим, у вас есть следующая структура каталогов, в которой вы хотите сгенерировать javadoc на file1.java и file2.java (package com.test), с размещением javadoc в C:\javadoc\test:

C:\
|
+--javadoc\
|  |
|  +--test\
|
+--projects\
   |
   +--com\
      |
      +--test\
         |
         +--file1.java
         +--file2.java

В командном терминале перейдите к корню вашего пакета: C:\projects.Если вы просто хотите сгенерировать стандартные javadoc для всех файлов java внутри проекта, выполните следующую команду (для нескольких пакетов разделите имена пакетов пробелами):

C:\projects> javadoc -d [path to javadoc destination directory] [package name]

C:\projects> javadoc -d C:\javadoc\test com.test

Если вы хотите запустить javadocsиз другого места вам нужно будет указать исходный путь.Например, если бы вы запускали javadocs в C:\, вы бы изменили команду следующим образом:

C:\> javadoc -d [path to javadoc destination directory] -sourcepath [path to package directory] [package name]

C:\> javadoc -d C:\javadoc\test -sourcepath C:\projects com.test

Если вы хотите запускать javadocs только для выбранных файлов .java, добавьте имена файлов источникаразделенные пробелами (вы можете использовать звездочку (*) для подстановочного знака).Обязательно укажите путь к файлам:

C:\> javadoc -d [path to javadoc destination directory] [source filenames]

C:\> javadoc -d C:\javadoc\test C:\projects\com\test\file1.java

Дополнительную информацию / сценарии можно найти здесь .

6 голосов
/ 25 июля 2014

Например, если бы у меня была структура исходного кода приложения, которая выглядела так:

  • C: \ b2b \ com \ steve \ util \
  • C: \ b2b \ com\ steve \ app \
  • C: \ b2b \ com \ steve \ gui \

Тогда я бы сделал:

javadoc -d "C:\docs" -sourcepath "C:\b2b" -subpackages com

И это должно создать Javadocsисходный код com-пакета и всех подпакетов (рекурсивно), находящихся в каталоге "C: \ b2b".

3 голосов
/ 19 октября 2017

просто перейдите в папку, в которой сохранен весь код Java, скажем E: / javaFolder, а затем javadoc *.java

пример

E:\javaFolder> javadoc *.java

1 голос
/ 29 апреля 2016

D:> javadoc * .java

если вы хотите создать док-файл пакета lang, путь должен быть таким же, как и ваш пакет lang в данный момент например Я создал имя папки javaapi и распаковал src zip файл. затем используйте команду как ниже

C: \ Users \ Techsupport1 \ Desktop \ javaapi \ java \ lang> javadoc * .java

1 голос
/ 09 января 2014

Ссылка на JavaDoc

Я верю, что это, безусловно, поможет вам.

javadoc -d C:/javadoc/test com.mypackage
...