aaron-bond / better-comments

https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments
MIT License
849 stars 161 forks source link

Multiline Comments Don't Seem to be Multiline #391

Open AlexDuchnowski opened 2 years ago

AlexDuchnowski commented 2 years ago

Hi Aaron, this extension rocks! I love how it helps me quickly find TODOs and comments that are asking questions or marking warnings. I just have one piece of feedback: Perhaps I'm misinterpreting the meaning of the multilineComments option, but I was hoping that in something like the following the line after the TODO would also be highlighted (I'm using #E72559 for the todo highlight color). The highlight would then stop after a blank comment line in a block comment. If this could be added across languages in the next update, that would be fantastic! image

caspercop commented 2 years ago

For me it works in CSS + HTML but I have to put the tag in each line of this block. Is that a feature to be able to have multi color in multi line code? Because my "intuitive" expectation was that a tag after the initialing comment character(s) the whole block will behave the same.

CSS Example - working with tag in each line: grafik

In Python its not working with triple quotes. But as this is context dependent if its a comment or a string, I guess this behavior is correct (?)

caspercop commented 2 years ago

@ AlexDuchnowski Is your example stored as a specific file type? Just tried Javascript and it s only working with a .js file not JS inside a HTML file.

JustBarnt commented 2 years ago

Doesn't work for me at all in any kind of file. "better-comments.multilineComments": true even with this set, I have to add the tag in front of the new line for it highlight. That's using // and /**/` in JavaScript. I assumed multi-line meant I wouldn't need to include the tag in each line.

AlexDuchnowski commented 2 years ago

@ AlexDuchnowski Is your example stored as a specific file type? Just tried Javascript and it s only working with a .js file not JS inside a HTML file.

@caspercop I tried saving the following comment in a file called test.js and it still isn't working the way I'd hope: image My hope would be that in this situation line 3 ("Second line") would also be highlighted yellow here. This was what I understood "better-comments.multilineComments": true to be enabling, but clearly that's not the case. At this point I'm not sure what setting this option actually does (the highlight in the example above stays the same regardless of whether I set the option to true or false).

aarondill commented 1 year ago

multilineComments enables parsing block comments. Comments are still only marked line by line.

Perhaps this option should be renamed, @aaron-bond. Many people seem to misunderstand it. Perhaps rename it to enableBlockCommentParsing or something of the sort.