问题标签 [docblocks]

当使用类工厂模式时，PhpStorm 仅在使用 docblock 注释时识别类。例子：

没有@var声明，PhpStorm 不知道doSomething()是\Some\Thing类的方法。如果完全由我决定，我会添加这些 docblock 注释。但是，我的同事不喜欢内联 docblock 注释。

有没有办法：

• 提交时忽略这些文档块（例如通过正则表达式过滤）或
• 教 phpstorm 如何根据 'some/thing' 参数找到类名或
• 使用另一种方法将这些评论仅保留在我自己的工作副本中？

我将 Php 与教义一起使用，并对它的 setter/getter 有疑问

根据 php.net 的混合是“混合表示一个参数可以接受多种（但不一定是全部）类型......”但是当我的 $id 是一个 int 并且将永远是时我为什么要使用它？我什么时候应该在诸如此类的 getter 和 setter 中使用“混合”？

我在一些遗留代码中添加了一些注释，并且遇到了 PHPDocumentor 的一个小问题。

这是一个例子：

我从命令行运行 PHPDocumentor，并得到一个充满文档的可爱文件夹。

文档看起来不错，但我得到 PHPDocumentor 编译错误，如下所示：

只是 PHPDocumenator 不必要地抱怨，还是有什么明显的我遗漏了？

我很难让 phpDocumentor 2 正常工作。

我有几个程序风格的文件，必须记录在案。我发现这样做的唯一方法是使用页面级 docblocks，但似乎它们在 phpDocumentor 版本 2 中不再正常工作。

stackoverflow 上的一个相关问题显示其他人在相同的问题中运行。在这个问题中，有两个建议：

1. 将 a 添加namespace到应记录的文件中
2. 从phpDoc 问题 910 开始，使用模板abstract或new-black

不幸的是，我无法找到工作。

1. 当我添加命名空间时，命名空间本身会显示在文档中，但不会显示在文档块的内容中。
2. 当我使用 phpDoc 2 的 phar 版本选择另一个模板（我尝试过zend，abstract和）时，我得到了错误。显然这是一个已知问题。new-blackPHP Warning: XSLTProcessor::transformToUri(): No stylesheet associated to this object in phar

编辑：

我又进了一步。我安装了 PEAR 版本的 phpDocumentor，并尝试了每个可用的模板。但我还远未达到目标：生成文档中的页面级文档块。
模板分为两类：

• clean, responsive,responsive-twig和old-ocean: 它们不会在生成的文档中输出页面级文档块。
• abstract,new-black和zend: 他们有一个文件部分的文档，显示预期的文件级文档。但是它们错过了几个资源（.js 文件和图像），因此它们看起来都一样，并且不能正常工作（导航窗格没有展开-折叠行为）。我查看了他们的 git 存储库，甚至那里的文件似乎也丢失了。

在这一点上，我只是想知道我是否正在寻找正确的方向：由于 phpDocumentor 2 中的主要回归和错误，不可能有一个显示文件级 docblocks 的文档的文档。

如果我真的走错了路，请建议我如何从我的 PHP 项目中获取有价值的文档。如果我走在正确的轨道上，请帮助我了解我缺少的难题中的重要部分。

在 PhpStorm 中，折叠或展开文件中所有注释（doc）块的快速方法是什么？

在这里的文档中说：

然后再往下说：

但我没有看到这是如何Alt modifer工作的？我按住 Alt 然后单击切换按钮，只有那个块单独折叠。我在顶级文档块以及属性/方法文档块中尝试了这个。我错过了什么吗？

您能否就如何使用 DocBloc 文档记录这段代码给我一些指导？

这$entityManager是 EnitiyManager 类的一个实例。

我经常在 GitHub 上发布 PHP 代码，并且在我的代码中我使用 docblock 评论，其中包含我的电子邮件地址，如下所示：

我担心这会吸引垃圾邮件发送者，我正在寻找一种方法来防止这种情况发生。有没有好的方法来做到这一点？

我看到一些开源项目使用这种格式：example.com:foo.bar。这足以欺骗垃圾邮件发送者吗？

问候，

在PhpStorm's设置中Editor/Inspections/PHP/PHPDoc/Missing @throw tag(s)有两个默认选择的选项：

• 忽略运行时异常
• 忽略逻辑异常

问题：为什么我要在创建 DocBlock 时忽略这些特定异常？我想这需要有充分的理由，因为默认情况下会检查这些选项。

Logic ExceptionsDomainException是类似or的例外InvalidArgumentException。是像或
Runtime Exceptions这样的例外RangeExceptionUnderflowException

注意：我使用的是 PhpStorm v8.0.3

我只是想知道是否有人知道任何使 Coda 使用我的 php docBlocks 的插件..？

我已经搜索了程序本身，似乎没有它的选项。

我也做了一个相当彻底的谷歌搜索，并提出了王牌。

I'm looking for a regex string to parse a property type from it's comment as below.

I'm using the ReflectionProperty class to get the comment as a string as the var dump below:

How would use the regex to return the type after @var and nothing else.

Thanks