Что такое инструмент JavaDoc и как им пользоваться?

Опубликовано: 6 Июля, 2021

Инструмент JavaDoc - это инструмент генератора документов на языке программирования Java для создания стандартной документации в формате HTML. Он генерирует документацию по API. Он анализирует декларации и документацию в наборе исходного файла, описывающего классы, методы, конструкторы и поля.

Перед использованием инструмента JavaDoc вы должны включить комментарии JavaDoc /**…………………..*/, содержащие информацию о классах, методах, конструкторах и т. Д. Для создания хорошего и понятного API документа для любого файла Java вы должны написать лучшие комментарии для каждого класса, метода, конструктора.

Комментарии JavaDoc отличаются от обычных комментариев из-за дополнительной звездочки в начале комментария. Он также может содержать теги HTML.

 // однострочный комментарий

/ * 
* Многострочный комментарий
* /

/ ** 
* Комментарий JavaDoc
* /

Написание ряда комментариев не влияет на производительность программы Java, поскольку все комментарии удаляются во время компиляции.

Формат JavaDoc: -
Он состоит из двух частей: - описание, за которым следуют теги блока.
Некоторые интегрированные среды разработки (IDE) автоматически создают файл JavaDoc, например NetBeans, IntelliJ IDEA, Eclipse и т. Д.

Генерация JavaDoc: -
Чтобы создать JavaDoc, вам не нужно компилировать файл java. Чтобы создать API документации Java, вам нужно написать Javadoc, за которым следует имя файла.

 javadoc file_name или javadoc package_name

После успешного выполнения указанной выше команды будет создано несколько файлов HTML, откройте файл с именем index, чтобы увидеть всю информацию о классах.

Теги JavaDoc

Тег	Параметр	Описание
@author	имя автора	Описывает автора
@param	описание	предоставить информацию о параметре метода или вводе, которое он принимает
@видеть	Справка	создать ссылку на другой элемент документа
@версия	имя-версии	укажите версию класса, интерфейса или перечисления.
@возвращаться	описание	предоставить возвращаемое значение

Чтобы сгенерировать JavaDoc в Eclipse: -

Выберите опцию «Создать JavaDoc» в меню «Проект», и появится мастер.
Укажите расположение файла JavaDoc на вашем компьютере, по умолчанию он будет на диске C.
Выберите проект, а затем пакеты, для которых вы хотите создать файл JavaDoc.
После этого с правой стороны выберите классы, для которых вы хотите создать JavaDoc, по умолчанию будут выбраны все классы.
Затем вы также можете указать, для каких классов будет создаваться JavaDoc, выбрав видимость.
Выберите место назначения, в которое будет помещен сгенерированный JavaDoc.
Затем нажмите «Далее» или «Готово».
Если вы выберете «Далее» в следующем окне, вы сможете выбрать заголовок документа и другие основные параметры.

Пример 1: -

Ява

 package exa;
 import java.util.Scanner;
 /**
 *
 * @author Yash
 */
 public class Example {
    /**
 * This is a program for adding two numbers in java.
    * @param args
 */
    public static void main(String[] args)
    {
        /**
        * This is the main method
        * which is very important for
        * execution for a java program.
        */
        int x, y;
        Scanner sc = new Scanner(System.in);
        /**
        * Declared two variables x and y.
        * And taking input from the user
        * by using Scanner class.
        *
        */
        x = sc.nextInt();
        y = sc.nextInt();
        /**
        * Storing the result in variable sum
        * which is of the integer type.
        */
        int sum = x + y; 
        /**
        * Using standard output stream
        * for giving the output.
        * @return null
        */
        System.out.println( "Sum is: " + sum);
    }
 }

Создание документа для указанного выше класса

 javadoc exa

Скриншот javadoc: -

Вниманию читателя! Не прекращайте учиться сейчас. Ознакомьтесь со всеми важными концепциями Java Foundation и коллекций с помощью курса "Основы Java и Java Collections" по приемлемой для студентов цене и будьте готовы к работе в отрасли. Чтобы завершить подготовку от изучения языка к DS Algo и многому другому, см. Полный курс подготовки к собеседованию .

Статьи Picked Java

Что такое инструмент JavaDoc и как им пользоваться?

Ява

РЕКОМЕНДУЕМЫЕ СТАТЬИ