Documenting (XML) Application Settings in Visual Studio 2010

Posted by SirLenz0rlot on Stack Overflow See other posts from Stack Overflow or by SirLenz0rlot
Published on 2010-05-11T09:47:23Z Indexed on 2010/05/11 9:54 UTC
Read the original article Hit count: 323

Hi all, 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?

© Stack Overflow or respective owner

Related posts about c#

Related posts about visual-studio-2010