Автоматическая генерация док-блоков в фасадах

Автоматическая генерация док-блоков в фасадах

Команда Laravel работает над инструментом для автоматической генерации док-блоков для фасадов в Laravel фреймворке.

@timacdonald87 автоматизировал генерацию док-блоков для фасадов.

Док-блоки для фасадов теперь автоматически обновляются при добавлении новых методов к их базовым классам или при изменении методов.

Это помогает IDE обеспечивать более точный и актуальный интерфейс при использовании фасадов. ❤️

— Taylor Otwell 🪐 (@taylorotwell) 5 января, 2023

Что это означает для сообщества Laravel, так это улучшенную поддержку IDE для фасадов, обеспечивающую более точное завершение кода:

Вот еще один пример из фасада Storage— он был обновлен вместе с FilesystemAdapter и FilesystemManager в запросе на извлечение #45517:

Если вы обновитесь до Laravel 9, вы должны увидеть улучшения в большинстве интерфейсов (несколько были обновлены вPull Request # 45504), таких как App, Cache, DB, Date, File, Http, Request и Vite, и это лишь некоторые из них.

Процесс начался в декабре 2022 года с первого pull request, представляющего этот инструмент, с улучшениями по сравнению с последующими выпусками для улучшения скрипта. Фасады можно генерировать и поддерживать в актуальном состоянии, выполнив команду:

php -f bin/facades.php

Этот инструмент был создан для фасадов, которые поставляются с фреймворком Laravel. Если вы следите за обновлениями фреймворка, вы, возможно, видели запросы на добавление док-блоков в фасады для определенных методов или групп методов, которые, по мнению разработчиков, нуждаются в этом. Теперь они в основном могут обновляться автоматически (не исключая конечно контроль со стороны разработчиков) благодаря этому скрипту!

Огромное спасибоТиму Макдональду и тем, кто помог просмотреть сгенерированные док-блоки (Docblocks), чтобы сделать это возможным!

Оригинал статьи - https://laravel-news.com/automatic-docblock-generation-on-facades.