在PhpStorm中标记@see
马尔辛·纳比亚韦克
我有以下代码：
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();
当使用CTRL+QinPhpStorm来查看类构造函数的文档时，我将看到：
null|string $splitter @see $splitter
我是在做错什么，还是应该配置PhpStorm以显示的描述$splitter here。我希望这里显示Splitter for words或链接到$splitter成员，而不仅仅是@see $splitter。
正如我检查的那样，那两个变量的名字没关系-即使构造器参数名称为$sPhpStorm仍然显示@see $splitter。
懒人
首先：内联时（如您所做的那样），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的问题跟踪器”提交“功能请求”票证（我会投赞成票）..但考虑到PhpDocumentor在这方面的表现..我非常怀疑PhpStorm开发人员是否会尽快实施它（他们确实喜欢遵循与引用工具相同的行为）。
本文收集自互联网，转载请注明来源。
如有侵权，请联系[email protected] 删除。
编辑于
相关文章
Related 相关文章
- 1
在Xcode中标记提交
- 2
在MongoDB中标记集合
- 3
在ListView中标记项目
- 4
在epplus中标记图例
- 5
在SQL中标记结果
- 6
在OCaml中标记〜f
- 7
在MKMapView中标记位置
- 8
在epplus中标记图例
- 9
在Azure门户中标记
- 10
在OpenCV中标记图像
- 11
在 C 中标记顺序
- 12
在双标中标记点
- 13
在sqlalchemy表中标记列
- 14
-I在GCC中标记（Linux）
- 15
在C＃中标记Enum
- 16
在Python中标记推文
- 17
在C ++中标记兴趣点
- 18
在Jenkinsfile中标记docker映像
- 19
在Vuejs模板中标记<component>
- 20
在PySpark中标记重复项
- 21
在Windows 8中标记
- 22
图例中标记的类型错误
- 23
在HTTP查询中标记或评论？
- 24
在C ++中标记兴趣点
- 25
在C＃中标记Enum
- 26
在行中标记连续系列
- 27
PhpStorm - 标记多行
- 28
如何在html中标记图像的版权？
- 29
获取WinCvs中标记文件的修订号
我来说两句