为 phpdoc 声明大量变量，而不用 /** 开头答案

【问题标题】：Declaring lots of variables for phpdoc without starting each with /**为 phpdoc 声明大量变量，而不用 /** 开头
【发布时间】：2009-11-04 01:48:53
【问题描述】：

我有许多变量的对象，我在 cmets 中声明和解释了这些变量。我对使用 phpDoc 的后续处理进行了非常彻底的评论，但是我还没有实际编译文档的经验。

我发现使用 phpDoc 表示法很烦人，即使我想要设置的唯一属性是描述，每个变量也会占用四到六行代码：

/**
 * @desc this is the description
 */

 var $variable = null;

我想使用以下符号：

# @desc this is the description
var $variable = null;

有没有一种简单的方法来调整 phpDoc 以接受它，或者当我实际尝试从中编译文档时它会给我带来麻烦？我现在不需要调整（尽管它当然值得赞赏），只是来自知道 phpDoc 的人的声明，这是否可行，而无需重新设计其大部分代码。

【问题讨论】：

【解决方案1】：

只写一行文档块

/** @desc this is the description */
var $variable = null;

问题解决了。

【讨论】：

【解决方案2】：

除了 Frank Farmer 提到的（+1 对他的解决方案），

/** 自 PHP 5 起在 PHP 标记器中被声明为 T_DOC_COMMENT。这意味着文档符号都从 /** 解析为 */。

您不能只使用# 或/* 来编写您的PHP 文档。

http://www.php.net/manual/en/tokens.php

【讨论】：

嗯，显然你可以，但我想你必须更改 PHPDoc（这不是我想要做的）。
我仍然不明白为什么如果您相应地更改 phpDoc 的解析，为什么不能使用 # 或 /* 作为文档？您愿意详细说明吗？
为什么要更改phpDoc的解析？
为什么不呢？我认为人们更改 phpDoc 以满足他们的需要没有任何问题。正如我所说，鉴于我已经提出了解决方案，我不打算这样做。然而，为了后代可能会偶然发现这一点，我希望您可以使用 # 或 /* 来编写您的 PHP 文档，如果您真的需要的话；它可能只是与一些工作有关。