Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to display full documentation of a method as you type in VS?

The title is pretty descriptive... Is there any extension that let me see FULL documentation of the method I'm typing ? I would like to see the documentation as I can see it in Object Browser with description of parameters and everything not just some "summary".

Of cause with an option to see all overrides. It may be part of intelisence or I don't know what it does not really matter.

like image 605
Rasto Avatar asked May 20 '10 20:05

Rasto


People also ask

How do I show documents in Visual Studio?

The idea is that you get a summary in the intellisense tooltip, and can press F1 to show the full help, or F12 to jump to the declaration (which usually includes the documentation).

How do you get function documentation in VS code?

Ctrl+Shift+Space works when the cursor is at the function parameters list.

What does IntelliSense do?

IntelliSense is a code-completion aid that includes a number of features: List Members, Parameter Info, Quick Info, and Complete Word. These features help you to learn more about the code you're using, keep track of the parameters you're typing, and add calls to properties and methods with only a few keystrokes.

How do I view parameters in Visual Studio?

This feature has now been released in the latest product update released version Visual Studio 2019 version 16.8. To access this feature, you will need to turn this option on in Tools > Options > Text Editor > C# or Basic > Advanced and select Display inline parameter name hints (experimental).


3 Answers

I'm sorry to say, but the answer is no. I can say this with confidence because I myself spent many, many hours looking for such a thing. Good luck.

like image 163
Adam S Avatar answered Sep 29 '22 06:09

Adam S


The idea is that you get a summary in the intellisense tooltip, and can press F1 to show the full help, or F12 to jump to the declaration (which usually includes the documentation).

I find I usually only need to read the full documentation once or twice and then the tooltips give me enough information to go on. Also, when I find myself needing the full documentation, I usually need to browse further (e.g. investigate the whole class and other methods). I can understand you wanting to see all the information, although I must say I personally prefer it the way it is.

I suspect if you actually had what you're asking for you might want to turn it off (or at least down) after a few weeks when it keeps taking over your whole screen to tell you stuff you already know about methods you type 20 times a day. That's probably why there aren't any tools out there to do it already.

If it helps, tools like Resharper give "better" intellisense tooltips. (I say "better" in quotes because I find Resharper gives me too much information, and the default Visual Studio approach of just showing me one overload at a time is actually a lot less 'in your face'. Many people like to have all this information at their fingertips though). The resharper tooltips still won't get you to a full copy of the documentation page though.

like image 11
Jason Williams Avatar answered Sep 28 '22 06:09

Jason Williams


Would Dynamic Help be close enough? (Help > Dynamic Help or Ctrl+F1, D)

Its a tool window that adjusts its content to what is under your caret in the text editor

like image 1
Pondidum Avatar answered Sep 28 '22 06:09

Pondidum