是否有正确的方法来通知注释解析器忽略docblock内的注释?

时间:2012-07-31 17:42:01

标签: php annotations phpdoc

假设我有一个docblock注释,例如,为了解析,phpDocumentor和任何注释解析器(让我们说Doctrine通用)。

<?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评论等。

是否有正确且相对标准的方式来通知注释解析器内联,以忽略docblock内的注释?

1 个答案:

答案 0 :(得分:0)

尝试使用--ignore-tags arg - 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