Как задокументировать класс и показать его параметры конструктора при создании экземпляра, используя автозаполнение Netbeans? - PullRequest
Новая
       5

Как задокументировать класс и показать его параметры конструктора при создании экземпляра, используя автозаполнение Netbeans?

0 голосов
/ 26 августа 2009

Я документирую структуру компании для использования с нашей IDE по умолчанию (Netbeans).

Это нормально, что мы посылаем в качестве параметров new Object, как здесь: 

$this->addControl(new TextControl('name', 'value'));

Я могу задокументировать параметры __construct() в обычном месте, но они не отображаются, когда вы делаете new <ctrl+space>.
Поэтому я попытался переместить этот документ в классный документ. Поэтому, когда вы набираете new, это показывает эту информацию.
Но это все равно не помогает мне автоматически заполнять все параметры конструктора.

Есть ли способ сделать это?

Я хотел бы иметь автозаполнение для параметров при первом создании экземпляра класса.

[EDIT] У меня есть этот код: 

/**
 * Classe da tag &lt;textarea&gt;
 * @param string $_name Nome do Controle e da tag
 * @param string $_label Texto que aparecerá antes do campo
 * @param string $_extra Usado para passar algum atributo a mais, como 'wrap'
 * @example $this->addControl(new TextAreaControl("comentarios", "Comentários: ", "wrap='off'"))
 */
class TextAreaControl {
[...]

    function TextAreaControl($_name, $_label, $_extra = "") {
        [...]
    }

    [...]   
}

Ответы [ 3 ]

0 голосов
/ 26 августа 2009

Поместите doc-блок над конструктором, а не над классом, как вы это сделали бы для любого другого метода.

0 голосов
/ 23 ноября 2009

Ответ таков: Netbeans понимает только методы __construct() как конструкторы классов.

Вы можете нормально документировать свой класс и метод конструктора, но используя __construct().
Таким образом, когда вы делаете $var = new Class<ctrl+space>, он покажет вам нормальные данные для метода конструктора.

0 голосов
/ 26 августа 2009

Находится ли ваша структура в рамках проекта? Если он находится в отдельном каталоге, вы должны щелкнуть правой кнопкой мыши по своему проекту, выбрать свойства, и должно быть что-то о «включенных файлах». Добавьте каталог фреймворков в этот список, и Netbeans проанализирует файлы.

Или вы говорите о phpdoc класса? Если это так, вставьте то, что у вас есть, потому что Netbeans должен получить его автоматически.

...