如何在教义中"comment out"注释条目

Question

给定以下属性，PHPDoc 注释包含 Doctrine 的注释：

/**
* @ORMColumn(name="id", type="integer")
* @ORMId
* @ORMGeneratedValue(strategy="AUTO")
*/
private $id;

"注释掉"其中一个注释行的最佳方法是什么？例如，像这样：

/**
* @ORMColumn(name="id", type="integer")
* @ORMId
* //Comment out please// @ORMGeneratedValue(strategy="AUTO")
*/
private $id;

是否有支持的方法或通用约定来执行此操作？

Answer 1

只需删除 @ 即可进行注释识别。

/**
* @ORMColumn(name="id", type="integer")
* @ORMId
* ORMGeneratedValue(strategy="AUTO")
*/
private $id;

Answer 2

只需将@替换为#

/**
* @ORMColumn(name="id", type="integer")
* @ORMId
* #ORMGeneratedValue(strategy="AUTO")
*/

Answer 3

我通常会添加@foo注释(此类不会发出任何问题)，以便在dockblocks内部注释掉。您可以注册全局注释以忽略：

AnnotationReader::addGlobalIgnoredName('foo');

这将应用于：

/**
* @Column(type="string", nullable=false, name="body")
* @foo type="string", nullable=false, name="body2" 
*/
protected $body;

您可以在原则 2.1 文档中验证它：

@Foo批注。它不是文档注释，也没有列入黑名单。对于教义注释，如何处理此注释并不完全清楚。根据配置，解析此注释时将引发异常(未知注释)

根据下面的引用，该示例不应引发任何异常，因为之前已注册@foo注释

Answer 4

只需在 @ 和指令的其余部分之间放置一个空格即可。

/**
* @ORMColumn(name="id", type="integer")
* @ORMId
* @ ORMGeneratedValue(strategy="AUTO")
*/