Comments incorrectly appended to hovered functions #310
Comments
|
This is a little bit more difficult to look out for since we don't track whitespace. I would recommend against doing this, but I'll see what we can do |
|
To be clear, this is an issue when using doc comments as well. Often floating doc comments will exist such as the following example and it happens there, too. When it happens in this case it's actually worse because it actually displays confusing documentation.
I think the way to address this is to only use the ones directly attached, so we'll likely have to check the whitespace in this particular case since it's semantic. |
|
I think this might be an issue specifically with multiline comments. I've noticed that the contents of multiline comments get appended to the doc comment below them. If there isn't a doc comment it just becomes one. It seems like multiline comments are just always treated as doc comments? |
A common pattern that I do in my code is use large comments to organize all the different types of functions that I write. My problem is that those large comments are incorrectly appended to hovered function documentation, as boxed in red below.
I expect only the comment directly above the function to be highlighted. In the case of the above picture, I only want to see "Does physics simulation".
Here is the example code that has the problem:
The text was updated successfully, but these errors were encountered: