使用 phpDocumentor 记录类常量组

Question

假设我有一个带有参数的方法，其有效值被声明为类常量（例如 PGSQL_ASSOC/PGSQL_NUM/PGSQL_BOTH） 。还有另一种方法，具有类似的参数，使用另一组类常量。有没有一种方法可以向 phpDocumentor 描述每组常量属于一组逻辑替代项？将它们分组记录并能够引用方法文档中的特定组将很有用。使用文档块模板并不会减少它，因为模板的简短描述被忽略（增加无用的混乱），而模板的长描述被附加到特定于常量的描述，导致某种向后的措辞（例如“BAR_MODE_1 does Foo::bar() 的操作模式”，而不是“Foo::bar() 的操作模式：BAR_MODE_1 执行此操作。”）。

例子：

class Foo {

    // this group of constants are valid modes for the bar() method
    const BAR_MODE_1 = 1;
    const BAR_MODE_2 = 2;
    const BAR_MODE_3 = 3;

    /**
     * @param int see Foo::BAR_MODE_* constants
     */
    public function bar($mode) { ... }

    // this group of constants are valid modes for the baz() method
    const BAZ_MODE_1 = 1;
    const BAZ_MODE_2 = 2;
    const BAZ_MODE_3 = 3;

    /**
     * @param int see Foo::BAZ_MODE_* constants
     */
    public function baz($mode) { ... }

}

Answer 1

另一种风格可能是使用 PHPDocumentor DocBlock 模板，

/**#@+
* This comment applies to each in the block
*
* @var varType 
*/
protected $_var1 = 1;
protected $_var2 = 2;
/**#@-*/

请参阅：http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.docblock

Answer 2

我首先想到的是 @see - 标签，它显示元素文档的链接。

/**
 * @param int 
 * @see Foo::BAR_MODE_* constants
 */
public function bar($mode) { ... }

更多详细信息可以在手册中找到。