PHPDoc: как задокументировать различные параметры свойств класса - PullRequest
2 голосов
/ 29 марта 2012

Есть ли способ с 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 Ответ

2 голосов
/ 29 марта 2012

Примерно это станет <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 подробности .

...