Visual Studio Intellisense for cref in Xml documentation

When you create XML documentation for C # methods in Visual Studio (I use 2010), you get Intellisense support for creating various XML tags like see, paramref, etc. On the other hand, when you add the aa cref attribute that you should use, what I find is a confusing format for describing types. This is the worst if you have several generics.

What I'm looking for is as follows. If you set the cref attribute on the see element, you have a list of Intellisense classes that matches what you typed, and then print the type description you want. Or when you set the cref attribute for the paramref element, you get a list of the parameters of this method.

Does anyone know some kind of add-on for Visual Studio to provide Intellisense for these cref attributes?

+8
c # visual-studio visual-studio-2010 intellisense xml-documentation
source share
1 answer

I wrote a lot of XML documentation recently, and I think ReSharper provides the functionality you are looking for with enhanced IntelliSense Code Completion - I use it all the time. Quick documentation should not be overlooked when writing documentation - with it you can see what the XML documentation will actually look like when compiled in html / chm, and it is updated in real time, so if I changed something in the documents with with the Quick Documentation window up, I see that it changes automatically - very useful for formatting, etc.

If you add Agent Smith to the mix (which apparently only works as a complement to ReSharper), it can add some useful Spell Checking, XML Comment Checker, Naming Checker and the simplest reflowing of comments (if you especially like to stay within a certain number of characters / lines) (with the first two, perhaps the most useful, since ReSharper provides the ability to apply naming conventions).

Hope this helps!

+4
source share

All Articles