Facades 上的自动 Docblock 生成
发布时间 作者 Paul Redmond
Laravel 团队一直在开发一个工具,用于自动生成 Laravel 框架中 Facades 上的 Docblock 生成。
.@timacdonald87 实现了 Facades 上的 Docblock 自动生成。
— Taylor Otwell 🪐 (@taylorotwell) 2023 年 1 月 5 日
当向其底层目标添加新方法或方法发生更改时,Facade docblocks 现在会自动更新。
这有助于 IDE 在使用 Facades 时提供更准确、更新的体验。❤️
这对 Laravel 社区意味着什么?那就是对 Facades 的 IDE 支持得到改进,从而提供更准确的代码补全。
以下来自 Storage Facade 的另一个示例:它已与 FilesystemAdapter 和 FilesystemManager 在 Pull Request #45517 中一起更新。
如果您更新到 Laravel 9 的最新版本,您应该会在大多数 Facades 上看到改进(多个 Facades 在 Pull Request #45504 中进行了更新),例如 App、Cache、DB、Date、File、Http、Request 和 Vite,仅举几例。
该过程始于去年 12 月的 第一个 pull request,引入了这个工具,并在随后的版本中进行改进,以完善脚本。通过运行以下命令,可以生成 Facades 并使其保持最新。
php -f bin/facades.php
此工具是为 Laravel 框架附带的 Facades 而构建的。如果您关注每周的框架发布,您可能已经看到 pull request,这些 pull request 添加了特定方法或开发者可能会发现需要添加的方法组的 Facade Docblocks。现在,由于这个脚本,它们可以基本保持自动更新(人工检查正确性)!
感谢 Tim MacDonald 和那些帮助审核生成的 Docblocks,使这一切成为可能!