В разработке есть задачи, которые повторяются из проекта в проект. Библиотеки, фреймворки, отдельные методы, параметры функций — всё это знакомо, но со временем забываются мелочи.
Работа часто останавливается не потому, что задача сложная, а потому что нужно вспомнить детали: как именно вызывается метод, в каком порядке передаются аргументы, какие есть нюансы у конкретного инструмента. Поиск в интернете занимает время, выбивает из контекста и часто приводит к нескольким вкладкам с похожими, но не совсем подходящими примерами.
Даже когда решение уже когда-то использовалось, приходится заново читать документацию или чужие статьи, чтобы восстановить картину целиком. В течение дня такие паузы на «вспомнить, как это делается» накапливаются и начинают заметно замедлять работу.
Один файл вместо десятков вкладок
В какой-то момент я понял, что большую часть этих ситуаций можно закрыть не поиском, а заранее сохранёнными примерами — в формате, который всегда под рукой и не требует лишних действий.
Так стал формироваться текстовый файл с примерами кода. Без сложной структуры или замудренного форматирования. Обычный файл, который открыт в Notepad++ и доступен в любой момент. Не нужно переключаться в браузер, ждать загрузки страниц или заново вчитываться в чужие объяснения.
Со временем, когда примеров становилось больше, этот подход начал ощутимо экономить время и избавлять от лишних остановок в работе.
Как я работаю с этим файлом в течение дня
Обычно всё выглядит так:
- файл открыт постоянно. За счет того что это простой текстовый файл, он занимает минимум ресурсов и никак не сказывается на скорости работы компьютера. Зато время доступа к полезной информации минимальное.
- Поиск примеров происходит по ключевым словам или хештегам. Например нужно найти как добавить обработчик на событие в битрикс, начинаешь искать по "EventHandler" и находишь пример добавления обработчик с использованием AddEventHandler().
- Просмотр примера. Посмотрел, понял, что это то что нужно значит можно использовать.
- Адаптация под текущую задачу. Найденный пример можно скопировать как есть и вставить в проект если этого будет достаточно или доработать под условия задачи.
Если в процессе работы появляется новое решение или удачная заготовка — я просто добавляю её туда же. При необходимости можно добавить какие-то небольшие комментария для лучшего понимания. Таким образом файл постепенно растёт.
Структура и навигация внутри файла
Чтобы файл не превратился в хаос, у него есть простая структура:
- примеры сгруппированы по языкам и фреймворкам;
- у кода есть короткие комментарии. При необходимости ссылки на документацию или связанные статьи;
- используются хештеги вроде
#php,#bitrix,#js,#css
За счет этого искать нужную информацию становится легко.
Примеры
Кому это подойдет
Такой формат вряд ли заинтересует тех, кто ищет готовые «волшебные рецепты» или универсальные решения на все случаи.
Он подойдёт тем, кто работает с PHP, Bitrix, Yii2, JavaScript, CSS и регулярно сталкивается с одними и теми же типами задач. Тем, кто ценит примеры из реальной практики и предпочитает смотреть на код, а не перечитывать объяснения.
Где посмотреть полный файл
Полный файл с примерами кода я выложил на Boosty .
Там собрана большая подборка решений, к которым я сам постоянно возвращаюсь в работе. Файл будет постепенно дополняться по мере появления новых задач и находок.
Заключение
Со временем у каждого разработчика появляется своя база знаний. Вопрос только в том, в каком виде она существует — в голове, в закладках или в удобном рабочем формате.
Этот файл — результат моего способа работать с кодом. Возможно, он окажется полезным и тебе.
