PhpStorm 是否允许在声明类型提示时跳过 PHPDoc 标记?
Does PhpStorm allow to skip PHPDoc tags when type hints is declared?
我使用 PHP 严格类型 declare(strict_types=1);
并通过项目声明类型。此外,我还在 PhpStorm 中启用了 PHPDoc 检查,例如 Argument PHPDoc missing
、Missing @return tag
等。
当我有明确的 return 类型和参数类型声明时,我希望 PhpStorm 不显示关于 PHPDoc 的警告。
这里是有效的 PhpStorm 示例代码。
/**
* @param Request $request
* @return JsonResponse
* @throws DBALException
*/
public function find(Request $request): JsonResponse
{
$user = $this->repository->find($request->get('id'));
if (!$user) {
throw new NotFoundHttpException();
}
return $this->json($user);
}
如我们所见,我有显式参数类型 Request $request
和 return 类型 : JsonResponse
声明,因此无需在 PHPDoc 中重复它们。
我想从 PHPDoc
中排除这些行
/**
* @param Request $request
* @return JsonResponse
*/
没有来自 PhpStorm 的警告,但仅在我已声明类型提示的情况下。尽管如此,当我的代码没有类型提示时,我还是希望看到警告。
是否可以实现?如果没有,是否存在一些 JetBrains 票证或者是否有一些 plugins/tools 可以涵盖我的情况?
Post自己回答。
原来有PHP检查的配置选项(PHPStorm 2019.2版本):
- 忽略 PHP带有 return 类型提示的文档(默认禁用)
- 允许带有类型提示的缺失参数(默认禁用)
我使用 PHP 严格类型 declare(strict_types=1);
并通过项目声明类型。此外,我还在 PhpStorm 中启用了 PHPDoc 检查,例如 Argument PHPDoc missing
、Missing @return tag
等。
当我有明确的 return 类型和参数类型声明时,我希望 PhpStorm 不显示关于 PHPDoc 的警告。
这里是有效的 PhpStorm 示例代码。
/**
* @param Request $request
* @return JsonResponse
* @throws DBALException
*/
public function find(Request $request): JsonResponse
{
$user = $this->repository->find($request->get('id'));
if (!$user) {
throw new NotFoundHttpException();
}
return $this->json($user);
}
如我们所见,我有显式参数类型 Request $request
和 return 类型 : JsonResponse
声明,因此无需在 PHPDoc 中重复它们。
我想从 PHPDoc
中排除这些行 /**
* @param Request $request
* @return JsonResponse
*/
没有来自 PhpStorm 的警告,但仅在我已声明类型提示的情况下。尽管如此,当我的代码没有类型提示时,我还是希望看到警告。
是否可以实现?如果没有,是否存在一些 JetBrains 票证或者是否有一些 plugins/tools 可以涵盖我的情况?
Post自己回答。
原来有PHP检查的配置选项(PHPStorm 2019.2版本):
- 忽略 PHP带有 return 类型提示的文档(默认禁用)
- 允许带有类型提示的缺失参数(默认禁用)