ventajas - Sugerencia de tipo variable en Netbeans(PHP)

que es netbeans pdf

Question

Es curioso si hay una forma en netbeans de dar pistas tipo sobre variables regulares, para que intellisense lo capte. Sé que puedes hacerlo para las propiedades de clase, los parámetros de función, los tipos de devolución, etc. pero no puedo entender cómo hacerlo para las variables regulares. Es algo que realmente ayudaría en situaciones en las que tiene un método que puede devolver diferentes tipos de objetos (como un localizador de servicios).

ex algo como:

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

En caso de usar $ algúnServicio después, netbeans proporcionaría todos los métodos disponibles definidos en la clase Some_Service.

Answer 1

¿Estás buscando documentar esas molestas variables mágicas ? (Lo hice; esta pregunta actualmente clasifica el mejor resultado para eso en Google. ¡Espero que esto ayude a alguien!)

La etiqueta @property permite documentar variables mágicas de php, aquellas implementadas usando __get() y __set() . La etiqueta debe usarse en la documentación inmediatamente anterior a la definición de la clase:

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

Esta notación desencadena autocompletar, probado en Netbeans 8.1 y PhpStorm 2016.1.

Answer 2

De acuerdo con netbeans.org/bugzilla/show_bug.cgi?id=267470 , la sintaxis cambiará en NetBeans 9 :

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

Además, vale la pena mencionar que puede agregar [] a un nombre de clase para indicar una matriz de objetos:

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

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

Y no olvide su declaración de use , por ejemplo, use Foo;

Answer 3

En netbeans 8.0.2, la plantilla vdoc le ofrece esto:

/* @var $variable type */

Sin embargo, Netbeans no reconocerá esto y no le dará la lista correcta de autocompletado para sus objetos. En su lugar, use esto, justo antes de su declaración de variable:

/** @var objectType $varName */

Realmente no he visto un gran uso para la plantilla stock vdoc , especialmente para las variables de clase que se usarán como objetos PDO o PDOStatement.

Una solución que uso es ir a Herramientas / Opciones / Editor / Plantillas de códigos (con PHP seleccionado como su Idioma) y agregar una nueva Plantilla. Llamé a mi sugerencia . Luego, en Texto expandido, usa la siguiente plantilla:

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

Answer 4

Sé que esta es una pregunta anterior, pero estaba buscando una respuesta similar para Eclipse / Zend Studio y esto también lo resolvió.

** Tenga en cuenta que debe estar en una sola línea con la apertura y el cierre explícitamente en este estilo ...

/* @var $varName Type_Name */

No hay otros formatos si ...

/**
 * @var $varName Type_Name
 */ 

o...

// @var $varName Type_Name

parecía funcionar en absoluto. Espero que ayude a alguien.

Answer 5

Una sola línea es todo lo que necesitas:

/* @var $varName Type_Name */

Vea este artículo en el blog PHP de NetBeans: https://blogs.oracle.com/netbeansphp/entry/defining_a_variable_type_in