search

niklaskallander / vs-unobtrusive-code

An extension for Visual Studio that lets you hide away obtrusive code like comments and logging, to let you focus on the actual flow of your application.
MIT License
24 stars 1 forks source link

Enhancement: please make this show documentation when hovering over member names #18

Open pardeike opened 7 months ago

pardeike commented 7 months ago

Hej, excellent extension! I find myself often writing a lot of docfx comments to document my open source library Harmony. This extension makes it possible to work with my code but I would love to preview the documentation that users would get when they use my library code. So I want to preview it during development and writing documentation.

I assume its a big ask but I had to ask anyway :-) Andreas (frän Stockholm)

niklaskallander commented 7 months ago

Hejsan!

Happy you find my experiment useful. (:

If I understand you correctly - you want the extension to expand the doc comment region (and/or toggle its opacity) for the specific member when hovering on the member's name. I assume only when hovering the identifier in its own definition? Not when hovering its identifier wherever it may be referenced in the same file?

Niklas (Skåne 🥇)

pardeike commented 7 months ago

That or even better if it would show the actual documentation like it would show for someone that tries to use this class/property/etc. Not sure if that is even possible. On second thought the toggle on hover as you suggested is maybe too distracting.

Btw, I found a bug:

/// <summary>...</summary>
///
#if NET5
[JsonIgnore]
#endif
public class Foo {}

does not toggle with alt-Q at all.