在 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 here 的描述。我希望这里显示Splitter for words 或链接到$splitter 成员，而不仅仅是@see $splitter。

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

Answer 1

首先：当内联时（就像你做的那样）PHPDoc 标签应该被{}包围，像这样：@param null|string $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 开发人员是否会很快实现它（他们确实更喜欢遵循与引用工具相同的行为）。