dev-notes

Это заметки (Quick Starts + Cheat Sheets) к различным библиотекам, которые используются недостаточно часто для размещения их кода в личные сниппеты.

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

Why?

У авторов библиотек если и есть документация, то она не всегда отражает наиболее вероятные Use Cases пользователя их библиотек. Например, все функции/методы в документации собраны в одну общую кучу. Это отнимает время и мотивацию — пока разработчик разберётся с использованием, могут уйти драгоценные часы. А библиотека, в будущем, может ещё в каком-нибудь проекте пригодиться.

Обычно с этим может помочь нейросеть, но та не поможет с Cheat Sheet и предостережением от грабель, а также не изобразит схематично главную суть.

Отличие от manуалов, туториалов, курсов

в том, что цель — разобраться, быстро вкатиться и не наступать на грабли при первичном или повторном использовании библиотеки, при этом не перегружая личные сниппеты.

Многие библиотеки, вероятно, будут использоваться лишь раз или два в тех или иных (пет-)проектах. Но будет удобно, чтобы последующие использования этих библиотек не были «с нуля». Такие заметки позволяют разобраться и сэкономить время и мотивацию, не растрачивая её ещё даже не приступив к написанию кода.

О заметках

Бойлерплейт (импорты, public static void main) стараюсь не писать. Паттерны, SOLID, архитектура и различные способы разделения ответственности также намеренно скрыты. Не рассматриваются все перегруженные методы, только самые полезные. Нет сигнатур функций/методов. Нет интерфейсов. Нейминг функций/методов передаёт только базовую суть, а не конкретную.

Если какой-то код зависит от другого кода, тот пишется в отдельной функции (объявление функции пишется на псевдоязыке и не принимает аргументы):

prepare() {
    System.out.println("Prepared!");
}

prepare();

System.out.println("Hello World");

Старт