wmjordan / Codist

A visual studio extension which enhances syntax highlighting, quick info (tooltip), navigation bar, scrollbar, display quality, and brings smart tool bar with code refactoring to code editor.
https://marketplace.visualstudio.com/items?itemName=wmj.Codist
GNU General Public License v3.0
315 stars 29 forks source link

Feature Request: Super Quick Info As XML Comment Viewer #122

Open TheXenocide opened 4 years ago

TheXenocide commented 4 years ago

Would it be feasible to use the same (or similar) rendering logic from Super Quick Info as a sort of XML Comment (the /// <summary>...</summary> kind) viewer in your own code. Something that could easily toggle to editing the XML comments but which is easier to read at a glance and navigate with.

Seems like it would be ideal to have similar configuration, but as separate settings for the inline preview (so the code viewer could show remarks, etc. by default even if you don't want those in the tool-tip side). Alternatively, it might be nice to just have all sections that are explicitly specified in the comments and maybe make the sections collapsible. Just some first thoughts; hopefully they make some sense.

wmjordan commented 4 years ago

Thank you for the feature request.

It reminded me that years ago I had the similar idea when I was developing the Super Quick Info and felt that the tool tip was a bit too small (but I did not want to enlarge it too much) and it might disappear if I clicked somewhere else, that was inconvenient if the Quick Info contained longish but useful information.

It could take quite some efforts to implement that feature. You can take a look at this extension to see whether it extension suite your needs: https://marketplace.visualstudio.com/items?itemName=OlegShilo.DocPreview

And have you ever tried the paid solutions, such as: https://marketplace.visualstudio.com/items?itemName=PeterMacej.VSdocman https://marketplace.visualstudio.com/items?itemName=sergeb.GhostDoc

TheXenocide commented 4 years ago

I took a look at those extensions (and have even used one of them a long while ago); they're not really exactly what I'm looking for, but I can appreciate that the task is not trivial and that there are probably other priorities. Thanks kindly for the recommendations though!

wmjordan commented 4 years ago

they're not really exactly what I'm looking for

Thank you for your feedback.

Do you mean the preview of the XML Doc can be a control like the code preview, rather than a separate tool window?