How to document a class property

Question

What is the correct syntax for an XML comment for a class property?

Answer 1

Install this: http://submain.com/products/ghostdoc.aspx

Right-click on the property, select 'Document This'. Fill in the blanks.

Answer 2

According to MSDN, link, it appears there isn't an official tag for Class Properties. But, I would use something like this:

/// <summary>Here is an example of a propertylist:
/// <list type="Properties">
/// <item>
/// <description>Property 1.</description>
/// </item>
/// <item>
/// <description>Property 2.</description>
/// </item>
/// </list>
/// </summary>

Answer 3

I'd suggest to use StyleCop. It does not only enforce (a bit to strong for my taste) you to comment, but also gives you a hint how the comments should be startet.