Indication du type de variable dans Netbeans (PHP)

Question

Je suis juste curieux de savoir s'il y a un moyen dans Netbeans de donner des indications de type pour les variables régulières, afin qu'intellisense les détecte. Je sais que vous pouvez le faire pour les propriétés de classe, les paramètres de fonction, les types de retour, etc. mais je n'arrive pas à trouver comment le faire pour les variables ordinaires. C'est quelque chose qui serait vraiment utile dans les situations où vous avez une méthode qui peut retourner différents types d'objets (comme un localisateur de service).

ex quelque chose comme :

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

Lorsque l'on utilise ensuite $someService, netbeans fournit toutes les méthodes disponibles définies dans la classe Some_Service.

Answer 1

Une seule ligne suffit :

/* @var $varName Type_Name */

Voir cet article dans le NetBeans PHP Blog : https://blogs.oracle.com/netbeansphp/entry/defining_a_variable_type_in

Note : Au moins, dans la version 8.2 ; La clé semble être :

• L'astérisque simple ( /* au lieu de /** ).
• Placer le type après le nom de la variable.
• Ne rien avoir avant et après l'indication de type (sauf les espaces blancs, mais même cela n'est pas autorisé lorsque le commentaire n'est pas sur une seule ligne).

Answer 2

Je sais que c'est une vieille question, mais je cherchais une réponse similaire pour Eclipse/Zend Studio et ceci l'a également résolu.

**Notez cependant qu'il doit être sur une seule ligne avec l'ouverture et la fermeture explicitement dans ce style...

/* @var $varName Type_Name */

Aucun autre format, que ce soit...

/**
 * @var $varName Type_Name
 */ 

ou...

// @var $varName Type_Name

a semblé fonctionner du tout. J'espère que cela aidera quelqu'un.

Answer 3

Vous cherchez à documenter ces ennuyeux magie (Je l'ai fait ; cette question est actuellement classée en tête de liste des résultats de Google. J'espère que cela aidera quelqu'un)

El @property vous permet de documenter magie les variables php - celles mises en œuvre à l'aide de __get() y __set() . La balise doit être utilisée dans la documentation précédant immédiatement la définition de la classe :

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

Cette notation déclenche l'autocomplétion, testée dans Netbeans 8.1 et PhpStorm 2016.1.

Answer 4

Según ce rapport de bogue la syntaxe sera modifiée en NetBeans 9 :

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

En outre, il convient de mentionner que vous pouvez ajouter [] à un nom de classe pour indiquer un tableau d'objets :

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

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

Et n'oubliez pas votre use déclaration, par exemple use Foo;

Answer 5

Dans netbeans 8.0.2, l'option vdoc Le modèle vous donne ceci :

/* @var $variable type */

Cependant, Netbeans ne le reconnaîtra pas et ne vous donnera pas la liste autocomplète correcte pour vos objets. Utilisez plutôt ceci, juste avant votre déclaration de variable :

/** @var objectType $varName */

Je n'ai pas vraiment vu une grande utilisation de l'action. vdoc Template, en particulier pour les variables de classe qui vont être utilisées comme objets PDO ou PDOStatement.

Une solution que j'utilise consiste en fait à aller dans Outils / Options / Éditeur / Modèles de code (avec PHP sélectionné comme langue), et d'ajouter un nouveau modèle. J'ai appelé le mien indice . Puis, sous Texte développé, utilisez le modèle suivant :

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