CODEWITHSUNDEEP
visual-studio-2010intellisensexml-commentssummaryremarks
Marcel
Marcel

Reputation: 15722

How to make Visual Studio intellisense to show the remarks portion of XML comments?

When typing code, I really like the intellisense feature of Visual Studio 2010 (Professional), especially that I am able to look up XML comments of types in use. (See Documentation from Microsoft). This works so far. However, the remarks section of XML code comments does not show up.

I would consider this an extremely useful feature, since there is often useful information that can not get easily guessed from the summary. (Which is why we have a the remarks section, i guess)

How to explore the remarks portion in Visual Studio 2010 (Professional) at the intellisense level? (I use DevXpress Coderush, if that matters, but I don't think so).

Upvotes: 16

Views: 5856

Answers (2)

Andrius R.
Andrius R.

Reputation: 189

Visual Studio v16.6.5 has an option in "Text Editor > C# > Advanced > Editor Help", called "Show remarks in Quick Info". It was added very recently and was enabled by default, but I haven't found any release notes or documentation about it. I checked version 16.5.2 and it does not have such an option.

When enabled, Quick Info shows the remarks section after adding a paragraph separator (empty line). When there is no summary section, the paragraph separator still gets added before the remarks (not sure if that's intentional).

The returns section is now also similarly shown, after the remarks section, separated by the word "returns". But there does not appear to be an option to disable this one.

Upvotes: 5

DFTR
DFTR

Reputation: 869

Put your cursor over the class/function/whatever that you want to see the full comments on, then press F12. Expand the comments section on the left of the editor pane.

Upvotes: 3

Related Questions