2011-01-04 3 views
47

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

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

+0

Я рекомендую взглянуть на следующие: http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc. html # runningjavadoc – Dartoxian

ответ

40

Вы можете сошлитесь javadoc 8 documentation

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

javadoc -d C:/javadoc/test com.test 
+0

Он автоматически добавляет дополнительные «/» после имени пакета для меня, например, если пакет: 'com.test', а внутри есть основной класс, тогда он должен сделать вывод как' com/test/Main.html', но он попытается написать в файл 'com/test // Main.html', странно! – Harshiv

20

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

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

Предполагая, что вы в ~ /, а исходное дерево java находится в ./saxon_source/net, и вы хотите рекурсивно пройти через всю исходную таблицу деревьев. b othe каталог и имя верхнего пакета.

mkdir saxon_docs 
javadoc -d saxon_docs -sourcepath saxon_source -subpackages net 
0

Link to JavaDoc

Я считаю, что это, несомненно, поможет вам.

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

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

  • C: \ b2b \ ком \ Стивом \ Util \
  • C: \ b2b \ ком \ Стиве \ приложение \
  • C: \ b2b \ ком \ стив \ ГИП \

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

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

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

9

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

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

В командной терминале, навигации к корню вашего пакета: C:\projects. Если вы просто хотите, чтобы генерировать стандартные Javadocs на всех 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 

Дополнительной информации/сценарий можно найти here.

+0

Просто сделайте что-нибудь вроде C: \> javadoc -d C: \ javadoc \ test C: \ projects \ com \ test \\ *. Java JavaDoc настолько расстраивает использование в противном случае (в Windows по крайней мере). –

1

D:> Javadoc * .java

, если вы хотите создать файл док пакета языки, то путь должен быть таким же, где ваш пакет Ланг в настоящее время например Я создал имя папки JAVAAPI и распаковать Src почтовый индекс файл. затем использовать команду, как показано ниже

C: \ Users \ Techsupport1 \ Desktop \ JAVAAPI \ Java \ языки> Javadoc * .java

1

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

пример

E:\javaFolder> javadoc *.java

Смежные вопросы