PHPDoc:如何记录不同的类属性选项

时间:2012-03-29 19:27:04

标签: php phpdoc

有没有办法用phpdoc来记录类属性可以采用的不同值以及它具有的效果。例如: -

class SomeClass {

   /**
   * Cell text align
   * 
   * null - table default
   * l - left align
   * r - right align
   * c - centre align
   * j - justify
   */
   public $align;

   Some code
}

有没有办法让phpdoc解析值描述对,以便将它们转换为定义列表或类似?

1 个答案:

答案 0 :(得分:2)

这样的内容将成为文档输出中的<ul>

class SomeClass {

   /**
    * Cell text align
    * 
    * Possible values: 
    * - null - table default
    * - l - left align
    * - r - right align
    * - c - centre align
    * - j - justify
    */
   public $align;

   // Some code
}

来自the manual page on DocBlock description details