Suggerimenti sul tipo di variabile in Netbeans (PHP)

Sono solo curioso di sapere se esiste un modo in netbeans per dare suggerimenti sul tipo per variabili regolari, in modo che intellisense lo raccolga. So che puoi farlo per proprietà di classe, parametri di funzione, tipi restituiti, ecc. Ma non riesco a capire come farlo per variabili regolari. È qualcosa che potrebbe davvero aiutare in situazioni in cui si dispone di un metodo che può restituire diversi tipi di oggetto (come un localizzatore di servizi).

ex qualcosa come:

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

Quando si utilizza $ someService in seguito, netbeans fornirebbe tutti i metodi disponibili definiti nella classe Some_Service.

Una sola riga è tutto ciò di cui hai bisogno:

/* @var $varName Type_Name */

Vedi questo articolo nel blog NetBeans PHP: https://blogs.oracle.com/netbeansphp/entry/defining_a_variable_type_in

Nota: almeno nella versione 8.2; La chiave sembra essere:

• Il singolo asterisco ( /*invece di /**).
• Posizionando il tipo dopo il nome della variabile.
• Non avere nulla prima e dopo il suggerimento del tipo (tranne lo spazio bianco, ma anche questo non è consentito quando il commento non è in una singola riga).

So che questa è una vecchia domanda, ma stavo cercando una risposta simile per Eclipse / Zend Studio e anche questo l'ha risolta.

** Nota però che deve essere su una sola riga con l'apertura e la chiusura esplicitamente in questo stile ...

/* @var $varName Type_Name */

Nessun altro formato se ...

/**
 * @var $varName Type_Name
 */ 

o...

// @var $varName Type_Name

sembrava funzionare affatto. Spero che aiuti qualcuno.

Stai cercando di documentare quelle fastidiose variabili magiche ? (L'ho fatto; questa domanda attualmente occupa il primo posto in Google. Spero che questo aiuti qualcuno!)

Il @propertytag ti consente di documentare le variabili php magiche , quelle implementate usando __get()e __set(). Il tag deve essere utilizzato nella documentazione immediatamente precedente la definizione della classe:

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

Questa notazione attiva il completamento automatico, testato in Netbeans 8.1 e PhpStorm 2016.1.

Secondo questo bug report , la sintassi cambierà in NetBeans 9 :

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

Inoltre, vale la pena ricordare che puoi aggiungere []al nome di una classe per indicare un array di oggetti:

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

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

E non dimenticare la tua usedichiarazione, ad esuse Foo;

In netbeans 8.0.2, il modello vdoc ti offre questo:

/* @var $variable type */

Netbeans non lo riconoscerà, tuttavia, e non ti fornirà l'elenco di completamento automatico corretto per i tuoi oggetti. Usa invece questo, appena prima della dichiarazione della variabile:

/** @var objectType $varName */

Non ho visto un grande utilizzo del modello vdoc stock , in particolare per le variabili di classe che verranno utilizzate come oggetti PDO o PDOStatement.

Una soluzione che utilizzo in realtà è quella di andare in Strumenti / Opzioni / Editor / Modelli di codice (con PHP selezionato come lingua) e aggiungere un nuovo modello. Ho chiamato il mio suggerimento . Quindi, in Testo espanso, utilizza il seguente modello:

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

Per NetBeans IDE 8.2 la sintassi è la seguente:

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

Ciò fornirà i suggerimenti sul tipo correttamente almeno per le variabili statiche.