Search code examples
c#visual-studio-2010documentationapplication-settings

Documenting (XML) Application Settings in Visual Studio 2010

I recently created a (C#) project with Visual Studio (2010) and used some Settings (which I created under Properties).

The only place I found where I can add some XML comments for my documentation, would be in Settings.Designer.cs. However this file is auto-generated so whenever I change the Settings, the comments are gone.

Even Visual Studio gives started giving mewarnings, "Missing XML comment for publicity visibly type or member .... "

My question here is: What is the neatest way to add XML comments to my Settings?

  • Is there a better place than Settings.Designer.cs?
  • Should I stop the file from being auto-generated? How?
  • Any other way?

I'm using Sandcastle Help File Builder by the way

Solution

  • If you open your settings (using default designer), you can find in properties window property "Description". Fill it in and it will be used as XML comment summary in autogenerated file.