Kotlin: как пользоваться документацией?

Question

[Andrey_Epifantsev]

Документация на Kotlin, на которую меня выводит Google, например эта, очень неудобна. Имеем длиннющий документ с описанием нескольких десятков функций без какого либо оглавления или списка этих функций.

Если мне нужна какая-то определённая функция, то пролистывать этот длиннющий файл совершенно неудобно, приходится методом тыка искать по словам. Например мне нужно уменьшить размер строки хранимой в данном классе. Сперва я пробую искать по слову 'size'. После прочтения описания нескольких функций я вижу, что это всё не то. Затем я догадываюсь поискать по слову length и наконец нахожу нужную функцию setLength.

Документация на другие библиотеки и языки обычно содержит в начале страницы оглавление или список функций. Например:
std::string в C++ - список разбитый на разделы, можно быстро охватить его взглядом, и перейти к детальному описанию заинтересовавших функций.
Или другой пример:
Строка в Qt - тоже есть список-оглавление, отсортированный по алфавиту. Можно быстро его просмотреть и перейти к нужным функциям.

Может я как-то неправильно использую документацию на Kotlin? Может там нужно нажать какую-то кнопку и откуда-то сбоку выедет оглавление или описания всех функций свернуться и я увижу их список? Или это может неправильная ссылка и эта документация предназначена не для пользователей языка, а для пользователей языка документация лежит на самом деле где-то в другом месте?

Comments

[Александр Юдаков]

У вас IDE какая? Блокнот?

[Andrey_Epifantsev]

Александр Юдаков, Android Studio

[Alex Wells]

Andrey_Epifantsev, так зачем в доку тогда заходить? Не проще ли в идеешке метод искать автокомплитом?

Хз даже как ответить. Мб я что-то упускаю, но у меня ни разу не было нужды искать что-то в АПИ доке. Как по мне, это всегда медленно и неудобно. В идеешке гораздо быстрее.

Answer 1

[Александр Юдаков]

В Android Studio пишете:
"hello".
— и после точки вам студия сама все подсказывает.

Контекстный поиск работает прям там же.



Хотите подробное описание метода?
Жмите Ctrl + Q.

Answer 2

[Andrey_Epifantsev]

Есть такая строчка кода:
val variant1 = StringBuilder()
в следующей строчке пишу:
variant1.size
выскакивает подсказка с одной единственной функцией: trimToSize. А как размер то поменять?

Нужно ещё догадаться, что надо искать по слову length.
А если нажимать Ctrl-Q то выскакивает окошко с сигнатурой функции. Никакого подробного описания оно не содержит:


Сигнатуру мне IDE и так подсказывает в процессе ввода.

Вот подробное описание в документации.

Единственный плюс, который я нашёл в Ctrl-Q - если щелкнуть по классу в этом окошке, то откроется описание этого класса, которого почему-то нет в официальной документации.

Answer 3

[alekseyHunter]

Нужно не "догадываться", а знать методы базовых классов.
Если не знаешь, учишь во время вывода подсказок Студии.

нет в официальной документации

Изучайте другие документации от разработчиков, тот же Metanit или StartAndroid.