Java Platform, Standard Edition (Java SE) helps you develop and deploy Java applications on desktops and servers. Java offers the rich user interface, performance, versatility, portability, and security that today’s applications require.
Whether you are working on a new cutting edge app or simply ramping up on new technology, Java documentation has all the information you need to make your project a smashing success. Use the rich set of code samples, tutorials, developer guides, API documentation, and more to quickly develop your prototype and scale it up to a real world application.
Java Platform, Standard Edition (Java SE)
Java SE related products enable you to monitor, profile, track usage, and centrally manage Java-based applications.
Java Embedded
Oracle Java SE Embedded delivers a secure, optimized runtime environment ideal for network-based devices.
Java Card technology provides a secure environment for applications that run on smart cards and other devices with very limited memory and processing capabilities.
| Javadoc | |
|---|---|
 |
|
| Тип | Генератор документации |
| Разработчик | Sun Microsystems |
| Операционная система | кроссплатформенная |
| Аппаратная платформа | Java Virtual Machine |
| Последняя версия | 1.50 |
| Лицензия | GNU GPL 2 + « >[1] |
| Сайт | docs.oracle.com/javase/8… |
Javadoc — генератор документации в HTML-формате из комментариев исходного кода на Java от Sun Microsystems. Javadoc — стандарт для документирования классов Java. Большинство сред разработки программного обеспечения автоматически генерируют HTML-документацию, используя Javadoc.
Javadoc также предоставляет API для создания доклетов и тэглетов, которые позволяют программисту анализировать структуру Java-приложения.
Содержание
Применение [ править | править код ]
Комментарии документации применяют для:
- документирования классов,
- интерфейсов,
- полей (переменных),
- конструкторов,
- методов,
- пакетов.
В каждом случае комментарий должен находиться перед документируемым элементом.
| Список дескрипторов Javadoc | ||
|---|---|---|
| Дескриптор | Описание | Применим к |
| @author | Автор | класс, интерфейс |
| @version | Версия. Не более одного дескриптора на класс | класс, интерфейс |
| @since | Указывает, с какой версии доступно | класс, интерфейс, поле, метод |
| @see | Ссылка на другое место в документации | класс, интерфейс, поле, метод |
| @param | Входной параметр метода | метод |
| @return | Описание возвращаемого значения | метод |
| @exception имякласса описание @throws имякласса описание |
Описание исключения, которое может быть послано из метода | метод |
| @deprecated | Описание устаревших блоков кода | класс, интерфейс, поле, метод |
| Ссылка | класс, интерфейс, поле, метод | |
| Описание значения переменной | статичное поле | |
Для документирования переменной можно использовать следующие дескрипторы: @see, @serial, @serialField, <@value>, @deprecated. Для классов и интерфейсов можно использовать дескрипторы: @see, @author, @deprecated, @param, @version. Методы можно документировать с помощью дескрипторов: @see, @return, @param, @deprecated, @throws, @serialData, <@inheritDoc>, @ехсерtion.
Пример [ править | править код ]
Пример использования разметки Javadoc для документирования метода [2] . Типы переменных указывать не нужно.