"@see" reference in docblock doesn't work when inline
Sample code to demonstrate the problem:
/**
* @see Someclass::someMethodOrProp - Correctly recognized.
* With holding Ctrl button I can mouse over both Someclass
* and someMethodOrProp and a popup hint appears.
* As well I can click and get to the respective source code.
*
* @property $something @see Someclass::someMethodOrProp - isn't recognized
* and is shown as plain text.
* HOWEVER:
* @property $something {} @see Someclass::someMethodOrProp - With '{}' as a separator this works as expected
* (both mouse over and clicks to get to sources).
* I came across this workaround just randomly trying different symbols as separators
* in attempts to get inline @see reference to work.
*/
Please sign in to leave a comment.
Inline @see tags should be surrounded by {}. E.g.:
* @property $something {@see Someclass::someMethodOrProp}Thank you! Typical RTFM situation :)
In this case it seems that phpstorm doesn't check the closing brace at all. Otherwise this:
wouldn't work.
Sounds like it, at least in 2019.2.3. It's better in the upcoming 2019.3 version