NetBeans: выбор типа переменной для добавления в комментарий

Question

Я хочу использовать функцию комментариев к переменным типам в NetBeans для PHP, но у меня возникают проблемы с выбором самого типа.

У меня отключен синтаксис (моя переменная называется $clause):

/* @var $clause type */

Но когда дело доходит до замены type чем-то, я не уверен, что использовать.Я использовал gettype($clause), чтобы определить тип рассматриваемой переменной, которая выдает string, но в раскрывающемся списке нет опции string для автозаполнения комментария в NetBeans.

Кроме того, параметры, перечисленные в , по меньшей мере мне чужды, и я не думаю, что разработчик должен будет использовать gettype каждый разим нужно определить тип используемой переменной.

Может кто-нибудь дать мне несколько советов по поводу типа использования?Это string, как я определил, или это определенный пользователем тип?

Я заметил в документации здесь , что в качестве примеров приведены типы Book и Movie, которые соответствуют названию class в приведенных примерах.Мой случай не содержит class, но нет примера, который бы напоминал мой случай.

Я ценю любую помощь, которую вы можете оказать мне.Спасибо.

Answer 1

Хм, я думаю, вы имеете в виду PHPDoc , нет? Это не функция Netbeans ...

Тип данных не имеет большого значения в долгосрочной перспективе, он только помогает вам разрабатывать самодокументированный код.

Наконец, если переменная $clause действительно содержит имя класса (чаще всего строку), DocBlock будет выглядеть так:

/**
 * @var $clause string Some class name.
 */

Обратите внимание, что докблоки должны начинаться с косой черты и двух звездочек.

Предложение @var имеет формат «имя переменной», «тип данных» и «описание».