如何在PhpStorm中为整个项目更新和生成DocBlock?

2022-08-30 22:53:57

我已经为php文档块设置了代码检查,所以现在如果它们丢失或不完整,我会收到警告。

Code inspection for PHPDoc

当我打开一个类时,我可以用来生成它们,或者只是通过一个方法前面开始一个注释,它就会被添加。Code > Generate > PhpDocBlocks/*

此外,如果退出文档块不完整或错误,我可以使用方法将方法的DocBlock与实际方法的签名相匹配。Update DocBlock

有没有办法应用这些,包括文档块生成,并在必要时在整个代码库上更新文档块,而无需在每个类中手动初始化?

我正在寻找一个批处理过程。


答案 1

在项目概述中,可以右键单击文件夹并选择 。也可以通过以下方式获得。Inspect CodeCode > Inspect Code

将弹出一个窗口,要求您提供更多详细信息,您也可以期望范围到整个上下文。

确保您的检测配置文件包含 PHPDoc。如果检查已经完成,那么您将有一个PHPDoc部分,

Result of Code Inspection

通过右键单击,您甚至可以对多个类进行操作。Apply Fix


答案 2

检查此屏幕截图:enter image description here

您可以在此处阅读有关创建文档的更多信息


推荐