php - 是否有正确的方法来指示注释解析器忽略文档块内的注释？

Question

假设我有一个 docblock 注释，它被解析，例如，phpDocumentor 和任何注释解析器（比如说 Doctrine common）。

<?php
/**
 * @author Blah <blah@example.com>
 * Class to handle the generation of lorem ipsum text for our templates
 * To declare as a service in the DIC, __uncomment__ the following annotation
 * @DIC\Service("textgenerator.loremipsum")
 */
 class LipsumGenerator implements TextGeneratorInterface { }

现在，我不希望@DIC\Service注释被默认解析，除非用户希望它被解析......显然我可以做任何事情来阻止它：将它存储在手册页而不是内联中，把它放在一个非docblock 注释等。

是否有一种正确且相对标准的方式来指示注释解析器inline以忽略 docblock 内的注释？

Answer 1

试试 --ignore-tags 参数 -- http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.ignore-tags

如果你想创建一个这样的注释的“永久列表”被忽略，你最好的选择是一个自定义的配置文件，你在运行 phpDocumentor 时总是使用它。您可以构建一个不断增长的注释标签列表，以被所有使用配置文件的 phpDocumentor 运行忽略。

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.config-files