Why do I get a PHPDoc warning in PhpStorm over this code

Question

I can't understand why PhpStorm gives me the following warning PHPDoc comment does not match function or method signature over this method:

/**
 * Create a new instance of the class
 * @param string $classname Class to instantiate
 * @return object the instance
 * @throw FactoryException If the class is not instantiable
 */
private function newInstance($classname) {
    $reflectionClass = new \ReflectionClass($classname);
    if (! $reflectionClass->isInstantiable()) {
        throw new FactoryException("The class $classname is not instantiable.");
    }
    return new $classname;
}

The warning isn't very specific, I've tried several things like changing the return type to "Object", "mixed" or even "int" (to try) but it didn't change. What is the problem here ?

MetalFrog · Accepted Answer · 2012-03-22 14:20:13Z

12

It should be @throws not @throw.

If you just type /** over the line of a function or class var declaration it'll auto insert a base PHPDoc for you. That's how I noticed the difference.

enter image description here

edited Mar 22, 2012 at 14:20

answered Mar 22, 2012 at 14:09

MetalFrog

10.7k1 gold badge25 silver badges24 bronze badges

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

5 Comments

Matthieu Napoli Over a year ago

I tried @throws but the warning is still there (I did the same as you did with typing /** but even the auto-generated docblock had the warning). Actually I have a beta version of PhpStorm 4.0, maybe it's just a bug?

MetalFrog Over a year ago

Funky, yeah I'm using 4.0 as well.

LazyOne Over a year ago

@Matthieu 1) It definitely should be throws 2) There are few issues with current v4 EAP build (116.101) in this regard (I'm having the same). From what I see (based on your comments) this function is in class that extends another class or implements interface and this function overrides one in parent class/interface. If so -- please compare PHPDoc blocks for them -- even if 1 character is different (e.g. "Create a new instance ..." vs "Create new instance ...") PhpStorm will report such error.

LazyOne Over a year ago

New EAP build should be available later today or tomorrow .. but I do not expect this to be fixed there (at least based on related tickets statuses).

Matthieu Napoli Over a year ago

OK I'll go with a bug then, even though one this method there is no overriding, that is the cas for another method of this class (implementing an interface).

ashnazg · Accepted Answer · 2012-03-22 18:41:23Z

1

If this method happens to implement/override from a parent class where a docblock exists for it, see if your tags match across both. Normally, tags in the parent will be inherited by the child, such that if the parent's method docblock already has those same tags (param, return, throws), then it is not necessary to list them in the child's docblock, unless they specifically need to say something different than the parent's does.

answered Mar 22, 2012 at 18:41

ashnazg

6,7282 gold badges34 silver badges40 bronze badges

1 Comment

Matthieu Napoli Over a year ago

That could be, but it's a private method ;), no overriding here

sheshadri maurya · Accepted Answer · 2016-06-30 09:30:27Z

1

Please refer to this link https://blog.jetbrains.com/webide/2011/05/phpdoc-inspections/ It is mentioned there that "The inspection reports a problem if a number of parameters described in PHPDoc comment and/or their types do not match a corresponding function or method declaration"

answered Jun 30, 2016 at 9:30

sheshadri maurya

111 bronze badge

Collectives™ on Stack Overflow

Why do I get a PHPDoc warning in PhpStorm over this code

3 Answers 3

5 Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

5 Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related