How to add documentation for my functions in Netbeans PHP?

Question

I tried the following,

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

But, when I tried to use it in another place, it says PHPDoc not found.

alt text

Any Ideas on how to get this to work in NetBeans PHP?

UPDATE :

The following is the updated syntax which will work in 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) {

Pekka · Accepted Answer · 2010-12-05 20:14:27Z

40

You are missing an asterisk * in the first line: Try

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

answered Dec 5, 2010 at 20:14

Pekka

451k150 gold badges990 silver badges1.1k bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

Raj Over a year ago

got it thanks. I did a little modification to the paramter name the parameter description also is now showing up. :)

teynon Over a year ago

For those trying to get a description to show up for classes: The description of the class when typing new myClass is pulled from the constructor method. So document the constructor with the information (as opposed to or in addition to the outside of the class) you want to show up in the hints.

Mahmoud Saleh Over a year ago

@Pekka 웃, i did that in netbeans 6.5.1 but for java method and when putting the mouse on the method and click control the documentation doesn't appear.

Mustafa Magdi Over a year ago

Does anyone know the shortcut for it?

Silvan Over a year ago

@MustafaMagdi Take a look to the answer from Benjamin Poignant -> in Netbeans /**[press enter] and you'll get your phpdoc automaticly (if the function exists)

Benjamin Poignant · Accepted Answer · 2014-11-14 10:21:20Z

21

Additional hint : Netbeans can make it for you :

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

Now write :

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

answered Nov 14, 2014 at 10:21

Benjamin Poignant

1,0648 silver badges18 bronze badges

1 Comment

Silvan Over a year ago

Thanks and +1 for the hint [press enter] for generating the phpdoc automaticly

2 revs · Accepted Answer · 2012-11-07 01:15:13Z

7

You need 2 ** on the comments opening for Netbeans to recognize it:

Should be

/**         
 *           
 */

not just a regular comment

/*
 *
 */

Example:

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

Netbeans automatically adds the function name

@return is optional but usefull

edited Nov 7, 2012 at 1:15

community wiki

2 revs
Paulo

Comments

A Salcedo · Accepted Answer · 2010-12-05 20:17:02Z

5

I believe the way to start you function comment is

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

Note the double asterisk to start your comment. You might want to check this php documentor.

answered Dec 5, 2010 at 20:17

A Salcedo

6,4888 gold badges33 silver badges42 bronze badges

Comments

toha · Accepted Answer · 2013-04-23 03:05:39Z

2

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

You may add since which version, what package, what subpackage, add type of parameters, i.e. string, mixed, bool, and what is the return.

answered Apr 23, 2013 at 3:05

toha

5,5454 gold badges43 silver badges56 bronze badges

Collectives™ on Stack Overflow

How to add documentation for my functions in Netbeans PHP?

5 Answers 5

5 Comments

1 Comment

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

5 Comments

1 Comment

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related