php storm自定义docblock

时间:2012-11-29 21:13:27

标签: phpstorm docblocks

有没有办法自定义php storm生成docblock的方法?

默认情况下,我希望将未知类型的变量视为字符串。

这是生成docblock的默认方式 (使用php storm 4.01)

/**
 * @param $name
 */
private function test($name){

}

如果可能的话,我想这样做:

/**
 * @param string $name
 */
private function test($name){

}    

1 个答案:

答案 0 :(得分:4)

,您无法为生成的@param提供默认类型。

只要可以从函数声明中检测到,PhpStorm就会提供正确的类型。在你的例子中,它是不可能的(它可以是任何东西)。

个人没有看到为什么它必须是字符串(或任何其他类型)默认的真正原因。未知/缺少类型告诉我,我需要完成编辑此PHPDoc块,以便它反映实际/正确的参数类型。已经输入了默认类型,这样的检查是不可能的(如果类型应该是某个类(例如Person)或者数组,那该怎么办?)

<强> P.S。 一种相关的(至少对实际主题):

这是可编辑PHPDoc模板的功能请求票证(可以定义@tags以及应该使用的顺序):http://youtrack.jetbrains.com/issue/WI-11111