Netbeans PHPDoc local variable not working

Question

I am trying to document my code more often and now I'm writing a class and want it to be fully documented. However, for some strange reason, local variable documentation (with PHPDoc of course) doesn't work..

I got this:

/**
 * A function for question
 * @param string $theVar The var to put in local var $aVar.
 */
public function theFunction($theVar) {
    /** @var string This is new local var, should have documentation but hasn't... */
    $aVar = $theVar;
}

So when I type 'the' and press space, and go to my function in Netbeans, it shows the function documentation.

But, when I type 'aVa' inside the function and press space and go to my variable, it says 'PHPDoc not found'.

I know in this case it wouldn't be a problem, but in a big function with lots of code it could actually be useful. However, for some reason it doesn't work and I have no clue why.

score 1 · Accepted Answer · answered Oct 14 '15 at 13:16

I don't think you can document internal variables like that. You can document class variable declarations and function parameters but the documentation doesn't say anything about a local function variable

You may use the @var tag to document the “Type” of properties, sometimes called class variables. Examples

class Foo
{
  /** @var string|null Should contain a description */
  protected $description = null;
}

Even compound statements may be documented:

class Foo
{
  /**
   * @var string $name        Should contain a description
   * @var string $description Should contain a description
   */
  protected $name, $description;
}

That's sad, I thought it'd be pretty useful. I think I should stay with // for local variables. — Joshua Bakker, Oct 14 '15 at 13:24

score 1 · Answer 2 · answered May 19 '16 at 06:32

1

This should work within a local variable. Just learning about PHPDoc, but I'm using it in PHPStorm and it works as long as you don't explicitly include the local variable name in the documentation.

paste this in your IDE:

<?php
    /** @var int This documentation is for $aVar. */
    $aVar = 5;

    /** @var int This documentation is for $bVar. */
    $bVar = 10;

    if ($bVar !== $aVar) {
        echo "False";
    }

answered May 19 '16 at 06:32

cyphi1

31
3

1

The question is about Netbeans. It does *not* work in Netbeans. – Ninj May 22 '17 at 12:08

score 1 · Answer 3 · edited Nov 10 '16 at 19:12

1

This is a different Tweak for Netbeans. You have to delete one *.

/* @var int This documentation is for $bVar. */
$bVar = 10;

In the 8.2 version of Netbeans, you have a template: vdoc to do quick:

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

edited Nov 10 '16 at 19:12

Tunaki

132,869
46
340
423

answered Nov 10 '16 at 19:08

Pascual Muñoz

189
1
5

Here is a related post: http://stackoverflow.com/questions/1798477/variable-type-hinting-in-netbeans-php – Pascual Muñoz Nov 10 '16 at 19:11

Netbeans PHPDoc local variable not working

3 Answers3