Comment ajouter de la documentation pour mes fonctions dans NetBeans PHP?

Question

J'ai essayé ce qui suit,

/* 
* 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); 

Mais, quand j'ai essayé de l'utiliser dans un autre endroit, il dit PHPDoc pas trouvé.

Des idées sur la façon d'obtenir ce travail dans NetBeans PHP?

MISE À JOUR:

Voici la syntaxe mise à jour qui fonctionnera dans 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

Il vous manque un astérisque * dans la première ligne: Essayez

/** 
* 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

Je crois que la façon de commencer votre commentaire de fonction est

/** 
* 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 
*/ 

Notez le double astérisque pour commencer votre commentaire. Vous voudrez peut-être vérifier cela php documentor.

Answer 3

Vous avez besoin de 2 ** sur l'ouverture des commentaires pour Netbeans de le reconnaître:

devrait être

/**   
*   
*/ 

pas seulement un commentaire régulier

/* 
* 
*/ 

Exemple:

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

Netbean s ajoute automatiquement le nom de la fonction

@return est facultative, mais utile

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. 
*/ 

Vous pouvez ajouter depuis la version, ce paquet, ce sous-paquet, ajouter le type de paramètres, à savoir la chaîne, mixte, bool, et ce est le retour.

Answer 5

indice supplémentaire: Netbeans peut le faire pour vous:

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

écrire maintenant:

/**[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; 
}