PHPCS/PHPMD:是否有PHP代码嗅探器/混乱检测器的方法来确保存在DocBlock?
有没有一种方法可以使用PHP代码嗅探器和/或PHP混乱检测器来检测我的类/属性/方法是否具有正确的docblock?例如:PHPCS/PHPMD:是否有PHP代码嗅探器/混乱检测器的方法来确保存在DocBlock?,php,phpmd,phpcs,Php,Phpmd,Phpcs,有没有一种方法可以使用PHP代码嗅探器和/或PHP混乱检测器来检测我的类/属性/方法是否具有正确的docblock?例如: class Foo { protected $bar; public function doStuff(){ // ... } } 上面的例子应该引起注意。但是,应通过以下示例: /** * Class Foo * @package Vendor\Module */ class Foo { /** * @v
class Foo
{
protected $bar;
public function doStuff(){
// ...
}
}
上面的例子应该引起注意。但是,应通过以下示例:
/**
* Class Foo
* @package Vendor\Module
*/
class Foo
{
/**
* @var Vendor\Module\Model\Bar
*/
protected $bar;
/**
* This method does stuff
* @return bool
*/
public function doStuff(){
// ...
}
}
根据定义,我对docblock是否正确(如果返回类型与返回的内容相匹配)不感兴趣,我的意思是:如果它也这样做就好了,但我想采取的第一步是确保docblock存在。的解决方案也适用于docblock存在性检查
这是我的栏类,有评论:
<?php
namespace PhpCSTesting;
use stdClass;
/**
* Class Bar
*/
class Bar
{
/**
* @var stdClass
*/
protected $bar;
/**
* This method does stuff
*
* @return boolean
*/
public function doStuff()
{
return true;
}
}
<?php
namespace PhpCSTesting;
class Foo
{
protected $bar;
public function doStuff()
{
return true;
}
}
这是我的Foo课程,没有任何评论:
<?php
namespace PhpCSTesting;
use stdClass;
/**
* Class Bar
*/
class Bar
{
/**
* @var stdClass
*/
protected $bar;
/**
* This method does stuff
*
* @return boolean
*/
public function doStuff()
{
return true;
}
}
<?php
namespace PhpCSTesting;
class Foo
{
protected $bar;
public function doStuff()
{
return true;
}
}
您可以根据需要更新和修改规则集。@LukasHajdu:我已经看过了这个答案,但如果我没有误解的话,这个问题更多的是验证docblock中的内容是否有效,而不是检查docblock是否存在。如果我错了,请纠正我。2017年,我在重复的问题中添加了2个新选项。检查它: