问题标签 [docblocks]

我一直使用注释来声明返回类型。例如：

但现在我看到还有另一种方式：

问题

我应该在这两者之间进行选择，同时使用它们，还是它们有一些我应该注意的根本区别？

docblock 的正确方法是什么？

我找不到任何说明这parent是有效关键字的文档。self也没有什么意义。我是否同时放置@uses和@see标签？

我正在尝试从反射方法为我的一个类创建一个接口，但我遇到了一个问题，即 getDocComments() 方法在我的暂存环境中失败。

这是我使用的测试代码：

在我的暂存环境中，$docBlock 是空的（如果我 var_dump() 它设置为 false）。我在暂存环境中的 PHP 版本是PHP Version 5.5.30-1~dotdeb+7.1. 在我的本地环境中PHP Version 5.6.27-0+deb8u1，它似乎有效。

虽然这个问题可能对我的环境非常具体，但我无法在我发现的任何在线 php 测试仪上重现它（我使用PHPTester和在线 PHP 函数对其进行了测试，它们允许针对多个版本的 PHP 进行测试，但没有一个具有精确的我在我的环境中拥有的版本。

这是一个关于 PhpStorm（可能还​​有其他 IDE）中的自动完成行为与 PHP 文档块结合的问题。

我必须在我的应用程序中分组类。首先，各种产品（CarProduct、FoodProduct 等）都有各自的类，它们都继承自 BaseProduct，而个别合同的对应物（CarContract、FoodContract 等）都继承自 BaseContract。

Now I have an instance of CarContract, and I wanna get some CarProduct specific information:

The autocompletion is not working as I like. There are two workarounds for this, but both are not nice:

1. Overload getProduct() in the subclass, just with updated @return docblocks
2. Add /** @var CarProduct $product */ everywhere, where I access the product of a CarContract

Is there a "usual" way to solve something like this, or are my workarounds the only solutions?

我正在尝试正确保存我的 php rest 服务器文档，所以我想知道我们如何记录返回值可以是 2 之一？

现在 FailMessage 和 SuccessMessage 都只是空类来充当一致的数据结构

更像这样的东西。

PhpStorm 生成一个空的doc-comments：

'/** + 空格' 或 'alt + 插入'

返回这个：

setter 或 getter 的生成也不起作用。

检查活动插件都已启用。是否有人面临类似问题或知道如何解决？

操作系统：Ubuntu 16.04

PhpStorm : 2017.1.2

插件：PHP 的东西 + symfony

更新：

PhpStorm日志：

2017-10-31 18:21:44,059 [2490534] WARN - s.quality.QualityToolAnnotator - phpcs：加载 /usr/lib/php/20151012/xdebug.so 失败：/usr/lib/php/20151012/xdebug.so ：未定义的符号：php_log_err for '/home/simpson/development/www/loanscrm/src/CrmBundle/Entity/Loan.php' on local 2017-10-31 18:23:27,559 [2594034] WARN - Detector.MessDetectorAnnotator - Mess所选配置的检测器路径为空 2017-10-31 18:23:27,869 [2594344] 信息 - lity.QualityToolProcessHandler - STDERR：加载 /usr/lib/php/20151012/xdebug.so 失败：/usr/lib/php/ 20151012/xdebug.so：未定义符号：php_log_err 2017-10-31 18:23:28,085 [2594560] 警告 - s.quality.QualityToolAnnotator - phpcs：加载 /usr/lib/php/20151012/xdebug.so 失败：/usr /lib/php/20151012/xdebug.so：未定义符号：php_log_err for '/home/simpson/development/www/loanscrm/src/CrmBundle/Entity/Loan.php' 在本地

'/** + enter' - 也不起作用:)

我正在为我的一个应用程序路由器在 docblock 下方写信。这样对吗？另外，告诉我每行的含义，因为我不知道。

/** * Router serving Activity log page. * @name get/activity_log * @function * @memberof module:routers/activity_log * @inner * @param {string} path - Activity log path * @param {callback} middlewear - Express middlewear. */

});

我发现了一个旧库，它使用@type停靠块内的标签，更具体地说是定义类属性，例如：

我无法在任何常用工具（phpDocumentor/1、phpDocumentor/2、DocBlox ...）中找到对此类标记的任何引用。

你知道这个标签可能来自哪个工具/文档吗？

我有大量的 PHP 行。许多方法包含实际上继承自它们覆盖的方法的文档块。

例子：

基本上，我希望子类中的文档块可以阅读：

因为据我了解，这是最佳实践。如果这是最佳实践，有人可以推荐我可以使用什么程序/技巧/代码将所有这些继承的文档更改为上述基本文档吗？

假设以下示例代码：

如何让 IDE 检测由@methoddocblock 声明的方法引发的异常？想知道这是否有可能做到，如果没有的话——我的选择是什么？

@throws在这种情况下，魔法方法中的声明似乎完全被忽略了。当然我可以禁用检查，但这对我来说不是干净的解决方案......