web-dev-qa-db-fra.com

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

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 introuvable.

alt text

Des idées sur la façon de faire fonctionner cela dans NetBeans PHP?

MISE À JOUR:

Ce qui suit est 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) {
phpnetbeansdocumentation-generationcode-completion
31
Lenin Raj Rajasekaran

Il vous manque un astérisque * en 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
 */
39
Pekka 웃

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

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

Maintenant écris :

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

Vous avez besoin de 2 ** sur l'ouverture des commentaires pour que Netbeans le reconnaisse:

Devrait être

/**         
 *           
 */

pas seulement un commentaire régulier

/*
 *
 */

Exemple:

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

Netbeans ajoute automatiquement le nom de la fonction

@return est facultatif mais utile

6
Paulo

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 .

5
A Salcedo
/**
 *
 * 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 quelle version, quel package, quel sous-package, ajouter le type de paramètres, c'est-à-dire chaîne, mixte, booléen et quel est le retour.

2
toha