¿Cómo agregar documentación para mis funciones en Netbeans PHP?

Question

He intentado lo siguiente,

/* 
* addRelationship 
* 
* Adds a relationship between two entities using the given relation type. 
* 
* @param fromKey the original entity 
* @param toKey the referring entity 
* @param relationTypeDesc the type of relationship 
*/ 

function addRelationship($fromKey, $toKey, $relationTypeDesc) { 
    $relationTypeKey = $this->getRelationTypeKey($relationTypeDesc); 

Pero, cuando traté de usarlo en otro lugar, dice PHPDoc no encontrado.

alguna idea sobre cómo conseguir que esto funcione en NetBeans PHP?

ACTUALIZACIÓN:

La siguiente es la sintaxis actualizada que trabajará en NetBeans PHP -

/** 
* addRelationship 
* 
* Adds a relationship between two entities using the given relation type. 
* 
* @param integer $fromKey the original entity 
* @param integet $toKey the referring entity 
* @param string $relationTypeDesc the type of relationship 
*/ 

function addRelationship($fromKey, $toKey, $relationTypeDesc) { 

Answer 1

Usted se echa en falta un asterisco * en la primera línea: Pruebe

/** 
* addRelationship 
* 
* Adds a relationship between two entities using the given relation type. 
* 
* @param fromKey the original entity 
* @param toKey the referring entity 
* @param relationTypeDesc the type of relationship 
*/ 

Answer 2

Creo que la manera de comenzar tu función es

/** 
* addRelationship 
* 
* Adds a relationship between two entities using the given relation type. 
* 
* @param fromKey the original entity 
* @param toKey the referring entity 
* @param relationTypeDesc the type of relationship 
*/ 

Tenga en cuenta el asterisco doble para comenzar su comentario. Es posible que desee comprobar esto php documentor.

Answer 3

Se necesitan 2 ** en la apertura de los comentarios Netbeans reconocerlo:

Debe ser

/**   
*   
*/ 

no sólo un comentario regulares

/* 
* 
*/ 

Ejemplo:

/** 
* function description 
* 
* @param *vartype* ***param1*** *description* 
* @param int param2 this is param two 
* @return void 
*/ 

Netbean s agrega automáticamente el nombre de la función

@ return es opcional, pero muy útil

Answer 4

/** 
* 
* Adds a relationship between two entities using the given relation type. 
* 
* @since 2.1.1 
* @package coreapp 
* @subpackage entity 
* 
* @param string $fromKey the original entity 
* @param mixed $toKey the referring entity 
* @param string relationTypeDesc the type of relationship 
* @return bool False if value was not updated and true if value was updated. 
*/ 

Puede añadir desde qué versión, qué paquete, lo sub-paquete, añadir tipo de parámetros, es decir, la secuencia, mixta, bool, y lo es el regreso.

Answer 5

Consejo adicional: Netbeans puede hacer por usted:

public static function test($var1,$var2) { 
    return $array; 
} 

Ahora escribe:

/**[press enter] 
public static function test($var1,$var2) { 
    return $array; 
} 

Tadaam:

/** 
* 
* @param type $var1 
* @param type $var2 
* @return type 
*/ 
public static function test($var1,$var2) { 
    return $array; 
}