如何在PhpStorm中为整个项目更新生成DocBlock?
How to update and generate DocBlock for the entire project in PhpStorm?
我已经为 php 文档块设置了代码检查,所以现在如果它们丢失或不完整我会收到警告。
当我打开一个 class 时,我可以使用 Code > Generate > PhpDocBlocks
来生成它们,或者只是通过 /*
在一个方法前面开始评论,它会被添加。
此外,如果现有文档块不完整或错误,我可以使用 Update DocBlock
将方法的 DocBlock 与实际方法的签名相匹配。
有没有一种方法可以在整个代码库中应用这些文档块生成和(如有必要)更新文档块,而无需在每个 class 中手动初始化?
我正在寻找批处理。
在项目概览中,您可以右键单击文件夹并select Inspect Code
。它也可以通过 Code > Inspect Code
.
获得
将弹出一个 window 要求您提供更多详细信息,您还可以期望整个上下文的范围。
确保您的检查配置文件包含 PHPDoc。如果检查 运行 通过,那么您将有一个 PHPDoc 部分,
通过右键单击您可以 Apply Fix
即使是多个 类。
查看此屏幕截图:
您可以阅读有关创建文档的更多信息here
我已经为 php 文档块设置了代码检查,所以现在如果它们丢失或不完整我会收到警告。
当我打开一个 class 时,我可以使用 Code > Generate > PhpDocBlocks
来生成它们,或者只是通过 /*
在一个方法前面开始评论,它会被添加。
此外,如果现有文档块不完整或错误,我可以使用 Update DocBlock
将方法的 DocBlock 与实际方法的签名相匹配。
有没有一种方法可以在整个代码库中应用这些文档块生成和(如有必要)更新文档块,而无需在每个 class 中手动初始化?
我正在寻找批处理。
在项目概览中,您可以右键单击文件夹并select Inspect Code
。它也可以通过 Code > Inspect Code
.
将弹出一个 window 要求您提供更多详细信息,您还可以期望整个上下文的范围。
确保您的检查配置文件包含 PHPDoc。如果检查 运行 通过,那么您将有一个 PHPDoc 部分,
通过右键单击您可以 Apply Fix
即使是多个 类。
查看此屏幕截图:
您可以阅读有关创建文档的更多信息here