Натякання на змінний тип у Netbeans (PHP)

Просто цікаво, чи є спосіб у netbeans давати підказки типу для регулярних змінних, так що intellisense це підхоплює. Я знаю, що ви можете це зробити для властивостей класу, параметрів функції, типів повернення тощо, але я не можу зрозуміти, як це зробити для звичайних змінних. Це те, що дійсно допомогло б у ситуаціях, коли у вас є метод, який може повертати різні типи об’єктів (наприклад, локатор послуг).

наприклад щось на зразок:

/**
 * @var Some_Service $someService
 */
$someService = ServiceLocator::locate('someService');

У разі використання $ someService пізніше, netbeans надаватиме всі доступні методи, визначені в класі Some_Service.

Все, що вам потрібно - один рядок:

/* @var $varName Type_Name */

Дивіться цю статтю в блозі PHP NetBeans: https://blogs.oracle.com/netbeansphp/entry/defining_a_variable_type_in

Примітка: Принаймні, у версії 8.2; Здається, ключовим є:

• Поодинока зірочка ( /*замість /**).
• Розміщення типу після імені змінної.
• Не маючи нічого до і після підказки типу (крім пробілів, але навіть це заборонено, коли коментар не знаходиться в одному рядку).

Я знаю, що це давнє запитання, але я шукав подібну відповідь для Eclipse / Zend Studio, і це також його вирішило.

** Зверніть увагу, що він повинен бути в одному рядку з відкритим і закритим явно в цьому стилі ...

/* @var $varName Type_Name */

Немає інших форматів, чи ...

/**
 * @var $varName Type_Name
 */ 

або ...

// @var $varName Type_Name

здавалося, взагалі спрацювало. Надія, що комусь допомагає.

Ви хочете задокументувати ці докучливі магічні змінні? (Я зробив; це запитання наразі займає найкраще місце серед результатів у Google. Сподіваюся, це комусь допоможе!)

@propertyТег дозволяє документувати магічний змінний PHP - ті , реалізовано з використанням __get()і __set(). Тег слід використовувати в документації безпосередньо перед визначенням класу:

/**
 * Class Contact
 * @property string $firstName
 * @property string $lastName
 */
class Contact extends Model {
   ...

Цей запис запускає автозаповнення, протестоване в Netbeans 8.1 та PhpStorm 2016.1.

Згідно з цим звітом про помилки , синтаксис зміниться в NetBeans 9 :

/* @var $variable VarType */    // vdoc1 (legacy syntax)
/** @var VarType $variable */   // vdoc (new syntax)

Також варто згадати, що ви можете додати []до імені класу, щоб вказати масив об’єктів:

/* @var $foos Foo[] */
$foos = // ...

foreach ($foos as $foo) {
    // $foo will be hinted as Foo here
}

І не забудьте своє useтвердження, напрuse Foo;

У netbeans 8.0.2 шаблон vdoc дає вам таке:

/* @var $variable type */

Однак Netbeans цього не розпізнає і не надасть вам правильний список автозаповнення для ваших об'єктів. Натомість використовуйте це безпосередньо перед оголошенням змінної:

/** @var objectType $varName */

Я насправді не бачив великого використання шаблону stock vdoc , особливо для змінних класу, які збираються використовувати як об'єкти PDO або PDOStatement.

Одне з рішень, яке я використовую, - це зайти в Інструменти / Параметри / Редактор / Шаблони коду (із вибраною мовою PHP) та додати новий шаблон. Я назвав свій натяк . Потім у розділі Розгорнутий текст використовуйте такий шаблон:

/** @var ${VAR_TYPE variableFromNextAssignmentType default="ClassName"} $$${VARIABLE variableFromNextAssignmentName default="variable"} */

Для NetBeans IDE 8.2 синтаксис такий:

class foobar{
    /** @var string $myvar: optional description here **/
    protected static $myvar;
}

Це забезпечить належним чином підказки для типу принаймні для статичних змінних.