Spiral group
_________________________________________________________________________________
< Раздел “Язык Java” > <
Раздел “Технологии Java” > < Основная страница >
Документация
по классам, интерфейсам и методам Java.
Статья опубликована: 04.09.2006
Изменена: 23.11.2006
В стандартной библиотеке существует огромное количество классов и методов, запомнить которые невозможно. Поэтому для нахождения информации о конкретном методе или классе необходимо пользоваться оперативной документацией интерфейса API. Документация интерфейса API является составной частью набора инструментальных средств Java SDK и создана в HTML формате. Для каждой новой версии JDK имеется собственная документация, которую можно скачать по адресу http://java.sun.com в разделе Download. Кроме API в документации также можно найти следующую информацию (рис. 1):
— инструментальные средства и их опции запуска (каталог tooldocs);
— описание различных языковых средств и технологий, которые составляют ядро Java (каталог guide).
Рисунок 1 — Структура каталога с
документацией к Java.
Открыть документацию по интерфейсам, классам или методам языка можно через файл docs/api/index.html. Окно документации разделено на три фрейма. В маленьком фрейме в правом углу приведены все доступные пакеты. Все пакеты можно увидеть также и в основном окне, щелкнув мышью на ссылке Overwiev в верхней строке основного окна. В правом нижнем фрейме перечислены все классы. Если щелкнуть кнопкой мыши на конкретном имени класса, то будет показана соответствующая документация по этому классу в основном окне.
Например, чтобы получить информацию о методах класса String, прокрутите левое нижнее окно, пока не увидите ссылку String. Щелкните на ней.
В основном окне для класса можно увидеть
после его названия дерево наследования (рис. 2). Например, для класса String:
java.lang.Object
java.lang.String
Рисунок 2 — Описание класса String.
Далее, как правило, следует перечисление
интерфейсов, которые реализует данный класс. После этого следует описание
назначения класса. Ниже следуют таблицы с кратким описанием полей,
конструкторов и методов класса (рис. 3). Щелкните мышью на имени этого
метода, чтобы получить его детальное описание. Например, если вы щелкните мышью
на ссылке charAt, то получите
полное описание метода charAt.
Рисунок 3 — Сводка методов класса String.
Если напротив метода вы увидите запись
Deprecated , то использование данного метода
нежелательно в данной версии JDK. Это означает, что данный метод может не во всех случаях отрабатывать
корректно, либо создан альтернативный метод, который более эффективен.
Кроме ссылки Overwiev в верхней строки основного окна присутствуют также еще несколько полезных ссылок: Tree, Deprecated, Index, Help. С помощью ссылки Tree можно отобразить полное дерево наследования классов. С помощью ссылки Deprecated можно увидеть список всех нежелательных методов. С помощью ссылки Index можно легко найти класс, метод или интерфейс, зная только его имя. С помощью ссылки Help можно подробно ознакомиться с организацией и функционированием API.
Ссылки:
1. Хорстман К.С., Корнелл Г. Библиотека профессионала. Java 2. Том 1. Основы. — М.: Издательский дом Вильямс, 2003. — 848 с.
2. JavaTM 2 Platform Standard
Edition 5.0 API Specification.
|
Автор:
|
< Раздел “Язык Java” > <
Раздел “Технологии Java” > < Основная страница >
