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

Question

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

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

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

 var $variable = null;

我想用下面的表示法:

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

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

Answer 1

只需编写单行docblock即可

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

问题解决了.