PHP - Комментирование - PullRequest
       12

PHP - Комментирование

0 голосов
/ 09 декабря 2010

Я недавно начал добавлять комментарии к объявлению свойств в моих классах php.Основная причина в том, что без этих комментариев NetBeans не понимает, что делать со свойствами, и поэтому у меня нет автозаполнения.Вот как это выглядит:

/**
 * @var MyClass what blabla about the instance.
 */
public $myClassInstance;

Вопрос заключается в следующем: когда у меня есть более одного экземпляра одного и того же класса, созданного в свойствах, существует ли способ «мультикомментария»?использовать только один раз @ var для каждого свойства под ним?(как следует)

/**
 * @var MyClass what blabla about the instance.
 */
public $myClassInstance;
public $myClassInstance2;

Хорошо, кажется глупым делать это сразу, но это удобно при объявлении первичных типов для примера, так что это будет выглядеть лучше и иметь меньше "мусора":

/**
 * @var Integer blabla
 */
public $index;
public $start;
public $end;

Ответы [ 3 ]

0 голосов
/ 09 декабря 2010

Нет официального стандарта для комментариев phpdoc , и особенно их интерпретации IDE.Вероятно, в этом случае лучше всего иметь @var phpdoc для каждой переменной в отдельности.

0 голосов
/ 09 декабря 2010

Хорошо, спасибо за ваши ответы :), наконец, я закончил делать однострочные комментарии, используя структуру Phpdoc:

/** @var Professionnel */
protected $auteur;
/** @var Categorie */
protected $categ;

Итак, у меня есть обе вещи, которые я искал: меньше комментариев и автозаполнение:)

0 голосов
/ 09 декабря 2010

Я предполагаю, что netbeans использует phpDocumentor.Из документов не получается, что такое возможно.

...