Как читать java-документацию?

Ответ 1

Здесь учебник.

И действительно, прочитайте его только тогда, когда это необходимо. Для остатка просмотрите учебник. Обычно Googling "[ключевое слово] сайт учебника: oracle.com" дает достаточно результатов.

Обновить, чтобы в качестве примера вы хотели бы найти Javadoc:

someString.split("\\.");

Здесь someString является экземпляром java.lang.String. Предполагая, что вы хотите начать с API документации root (я сам предпочитаю набирать только "java.lang.string javase api site: oracle.com" в адресной строке Firefox, чтобы получить его прямо для меня (если вам повезет и еще не было в истории браузера), или просто проверить его в моей среде IDE), затем прокрутите в главном кадре до java.lang package и нажмите ссылку, затем в сводке классов проверьте String и щелкните ссылку, затем в сводке методов проверьте метод split() и нажмите ссылка.

Javadoc API Java SE является сжатым, но довольно полным и предоставляет ссылки на другие javadocs, где вы ожидаете их. Например, в нижней части String#split() javadoc вы видите ссылку "См. Также" на класс Pattern, который, в свою очередь, объясняет, что регулярное выражение в представлении класса.

Ответ 2

Прочтите его по мере необходимости. Как и в случае с проектом. Документация в основном зависит от формата, а не от формата обучения.

В противном случае, если вы хотите действительно прочитать что-то, чтобы изучить SDK, например, прочитайте учебную книгу.

Ответ 3

Представьте себе javadoc как просмотр альбомов в itunes. Верхний левый фрейм - это список пакетов. Это похоже на список художников. Выбрав одно из этих изменений, показано в нижнем левом фрейме. Нижний левый фрейм - это список классов/интерфейсов в выбранном выше пакете. Это нравится выбирать исполнителя и показывать список альбомов. Затем вы можете выбрать один из классов/интерфейсов, и подробный вид его появится в главном фрейме. Это похоже на список дорожек для выбранного альбома.

Аналогия ITunes в стороне, детали основного кадра показывают всю общедоступную и защищенную информацию, необходимую для взаимодействия с этим классом или интерфейсом. В верхней части показано иерархия наследования и описание класса. Ниже приведен краткий обзор всех полей, конструкторов и методов, которые являются общедоступными или защищены в классе. Вы можете щелкнуть ссылку на любом из них, чтобы перейти к полному описанию. В нижней части сводки находится список всех унаследованных методов.

Любые классы, на которые ссылаются в javadoc, такие как аргументы или типы возврата, будут ссылками. Если вы нажмете ссылку, она перейдет к javadoc для этого класса. Таким образом, довольно легко перемещаться по всем классам, необходимым для выяснения того, что происходит. Это не совсем красиво, но это работает. Будучи html, вы даже можете открывать ссылки на новой вкладке и, следовательно, легко открывать все связанные классы сразу.

Один последний совет - есть дополнительные опции в верхней части панели подробностей. Одним из них, который я использую много, являются ссылки Frames/No Frames. Это добавит или удалит рамки пакета и класса слева. Если вы открываете другие классы на новых вкладках, или иногда, если вы находите класс с помощью Google, вы завершаете страницу без дополнительных кадров. Просто нажмите тег Frames, и они будут добавлены на страницу.

Ответ 4

JavaDoc - это просто ссылки. Это отлично подходит для ответа на вопрос о форме "что это делает (класс/метод)?" но ужасно для чего-то еще.

Если вы смущены JavaDoc, вы должны забрать книгу или найти онлайн-учебник. Используйте документацию в качестве ссылки для ответа только на конкретные вопросы, и, возможно, вы не будете так запутаны.

Ответ 5

Представьте, что у вас есть String, и вы пытаетесь решить, как преобразовать его в верхний регистр. Посмотрите на javadoc для String, http://java.sun.com/javase/6/docs/api/java/lang/String.html (или из вашей ссылки выше, просто прокрутите вниз, чтобы найти строку в нижнем левом списке.

Вы найдете там метод toUpperCase(). Вы можете нажать на нее, чтобы найти детали. И вы увидите все другие методы, которые описывают типы вещей, которые вы можете "сделать" для строки.

И там также есть список конструкторов, которые расскажут вам, как вы можете "создать" строковый объект.

Может быть, это не слишком сложно для String, поэтому попробуйте что-то более сложное: как вы создаете BufferedOutputStream?

Ответ 6

Самое полезное для меня изучение API Java SE - это сделать " Учебники Java". Он охватывает почти весь Java SE гораздо более организованно, чем JavaDocs. После того, как вы прочитаете интересующие вас биты, JavaDocs станет более понятным.

Обычно я читаю JavaDocs для битов, которые меня интересуют через IDE. Я использую Netbeans, который автоматически отображает JavaDoc как часть его завершения кода. Таким образом, я могу частично ввести имя класса или метода, которое я собираюсь использовать, а затем просматривать JavaDocs предложений до тех пор, пока не найду то, что хочу.

Ответ 7

Во-вторых, все вышеперечисленные путаные пользователи. Что касается меня, исходящего из активного использования Windows API для VB classic, Java API не является просвещенным.

Да, Java API предоставляет исчерпывающую информацию о себе, о том, что каждый класс делает, и о структуре всего этого; но для чего-то полезного во время разработки он в значительной степени сдерживает, а не ссылается на решения и полезный код.

Учтите, что любой, кто знаком с Java, вряд ли может вспомнить или запомнить, какие функции являются частью каждого пакета. Затем для поиска метода используется функция, класс или уже определенный термин - кошмар.

Что касается документов API Java API: одна вещь отличается и исключительно специфична для среды и языка; это совершенно другая игра с мячом, когда она больше ориентирована на простое отличие, несмотря на то, что она непоследовательна для новичков.

Я считаю, что люди найдут шаги к началу кодирования, значительно упрощенные путем капитального ремонта раскладки документации по неорганизованному API-интерфейсу Java.