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 анализировать пары значение-описание, чтобы он превратил их в список определений или что-то подобное?


php phpdoc
person rgvcorley    schedule 29.03.2012    source источник
comment
Несвязанные: как вы собираетесь гарантировать, что переменная содержит эти значения? Вы думали о защищенной переменной с общедоступными геттерами и сеттерами?   -  person cmbuckley    schedule 29.03.2012

Ответы (1)


arrow_upward
2
arrow_downward

Что-то вроде этого станет <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
}

Из страницы руководства с подробным описанием DocBlock.

person cmbuckley    schedule 29.03.2012
comment
Фантастика! Большое спасибо! - person rgvcorley; 30.03.2012
comment
Вскоре мы с нетерпением ждем PHPDocumentor 2 @ www.phpdoc.org, хотя на момент публикации этого поста он еще не закончен. - person Webnet; 23.02.2013