php - 在 PhpStorm 中标记 @see

Question

我有以下代码:

class A {

    /**
     * Splitter for words
     *
     * @var null|string
     */
    private $splitter = '-';

    /**
     * Desc...
     *
     * @param null|string $splitter   @see $splitter
     */
    function __construct(
        $splitter = null
    ) {
      // implementation
    }

}

$a = new A();

当在 PhpStorm 中使用 CTRL+Q 查看类构造函数的文档时，我将看到:

null|string $splitter @see $splitter

我是在做错什么，还是应该将 PhpStorm 配置为在此处显示 $splitter 的描述。我希望这里显示 Splitter for words 或链接到 $splitter 成员，而不仅仅是 @see $splitter。

正如我所检查的那样，这两个变量具有相同的名称并不重要 - 即使构造函数参数名称是 $s PhpStorm 仍然显示 @see $splitter .

Answer 1

首先:当内联(就像您所做的那样)时，PHPDoc 标记应该被 {} 包围，像这样:@param null|字符串 $splitter {@see $splitter}

其次:PhpStorm 不会解析 @param 或 @return 描述中的附加/内联标签——它只会在以下情况下解析它@see 位于单独的行中，或者内嵌在主要(方法)描述部分中。换句话说:@param 描述中的内联将不起作用(非常不幸)。

在这方面，PhpStorm 的行为就像 PhpDocumentor 本身(使用版本 2.6.1 进行了检查)。

代码:

<?php

class PHPDoc_See
{

    /**
     * Splitter for words
     *
     * @var null|string
     */
    private $splitter = '-';

    /**
     * Desc...  {@see $splitter}
     *
     * @param null|string $splitter Bla-Bla {@see $splitter}
     */
    function __construct($splitter = null)
    {
        // implementation
    }
}

PhpDocumentor 结果:

在这方面，PhpStorm 表现得更好一些——至少它在主要(方法)描述中解析了 @see。

---

唯一可行的解​​决方案(如我所见)是将 @see 标记放在不同的行上:

/**
 * Some Description
 *
 * @param null|string $splitter Bla-Bla
 * @see $splitter
 */

---

当然:您可以随时向PhpStorm's Issue Tracker提交功能请求票。 (我会投赞成票)..但考虑到 PhpDocumentor 在这方面的表现..我严重怀疑 PhpStorm 开发人员是否会很快实现它(他们确实更喜欢遵循与引用工具相同的行为) .