3

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

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

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

 var $variable = null;

我想使用以下符号:

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

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

4

2 回答 2

12

只写一行文档块

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

问题解决了。

于 2009-11-04T01:53:07.250 回答
2

除了弗兰克·法默(Frank Farmer)提到的(他的解决方案+1),

/**自 PHP 5 起在 PHP 分词器中声明T_DOC_COMMENT。这意味着文档符号都是从/**到解析的*/

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

看:

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

于 2009-11-04T01:56:37.190 回答