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

时间:2015-05-27 14:28:33

标签: php phpstorm phpdoc

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

Code inspection for PHPDoc

当我打开一个课程时,我可以使用Code > Generate > PhpDocBlocks生成它们,或者只是在方法前面通过/*开始发表评论,然后将其添加。

此外,如果现有的doc块不完整或错误,我可以使用Update DocBlock来匹配方法的DocBlock与实际方法的签名。

是否有一种方法可以应用这些文件块,如果需要,可以在整个代码库中更新doc块,而无需在每个类中手动初始化它?

我正在寻找批处理。

2 个答案:

答案 0 :(得分:25)

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

会弹出一个窗口,要求您提供更多详细信息,并且您也可以将范围视为整个上下文。

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

Result of Code Inspection

通过右键单击,即使是多个班级也可以Apply Fix

答案 1 :(得分:8)

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

您可以阅读有关创建文档here

的更多信息