How to write comments / documentation for variables / fields / lists in VS 2010?

Question

There is

///

///This is summary for some class or method
///

documentation for classes or methods. But how t

Answer 1

Seems to work perfectly fine in Visual Studio 2010. I defined a List as a private field with a comment inside my MainForm class.

They won't work for local variables defined within functions though.

Answer 2

Edit: it looks like <var> is only supported for JavaScript.

As of Visual Studio 2012 you can add this documentation using the <var> element.

Here's Microsoft's documentation on it:
https://msdn.microsoft.com/en-us/library/hh542722(v=vs.110).aspx

Answer 3

As far as I know, adding comments for intellisense will not work for local variables declared within functions. If you were to make your local list an instance variable of the class, you would be able to do this.

Answer 4

As others mentioned, you can't get IntelliSense for local vars. However: If your function is so large that a "regular" comment is not close enough to read near the place where you're using the var, then the right fix is to refactor the function -- break it up into multiple, smaller methods, with fewer vars. I don't think this feature should exist, as it would serve only to facilitate writing excessively large functions.

Answer 5

The same way as you write summary for classes and methods work for variables.

Answer 6

You can add such XML documentation comments to any class member, not inside a member (method, property, etc).