为phpdoc声明大量变量而不用/ **开始每个变量

时间:2009-11-04 01:48:54

标签: php documentation phpdoc

我有很多变量的对象,我在评论中声明并解释。我正在非常彻底地评论以便稍后使用phpDoc进行处理,但是我还没有实际编译文档的经验。

我觉得非常烦人的是,使用phpDoc表示法,每个变量都会占用四到六行代码,即使我想要设置的唯一属性是描述:

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

 var $variable = null;

我想使用以下符号:

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

是否有一种简单的方法可以调整phpDoc来接受这个,或者当我真正尝试编译文档时它会给我带来麻烦吗?我现在不需要调整(虽然它当然很受欢迎),只是来自知道phpDoc的人的声明,这是否可行,而无需重新设计其代码的大部分内容。

2 个答案:

答案 0 :(得分:12)

只需编写单行docblocks

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

问题解决了。

答案 1 :(得分:2)

除了Frank Farmer提到的(他的解决方案+1),

自PHP 5以来,

/**在PHP tokenizer中被声明为T_DOC_COMMENT。这意味着文档符号都是从/***/解析的。

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

  

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