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: 301

Filed under:

c#

|

visual-studio-2010

|

documentation

|

application-settings

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#

.NET WebRequest.PreAuthenticate not quite what it sounds like

as seen on West-Wind - Search for 'West-Wind'
I’ve run into the problem a few times now: How to pre-authenticate .NET WebRequest calls doing an HTTP call to the server – essentially send authentication credentials on the very first request instead of waiting for a server challenge first? At first glance this sound like it should be easy:… >>> More
HttpWebRequest and Ignoring SSL Certificate Errors

as seen on West-Wind - Search for 'West-Wind'
Man I can't believe this. I'm still mucking around with OFX servers and it drives me absolutely crazy how some these servers are just so unbelievably misconfigured. I've recently hit three different 3 major brokerages which fail HTTP validation with bad or corrupt certificates at least according to… >>> More
Dynamic Type to do away with Reflection

as seen on West-Wind - Search for 'West-Wind'
The dynamic type in C# 4.0 is a welcome addition to the language. One thing I’ve been doing a lot with it is to remove explicit Reflection code that’s often necessary when you ‘dynamically’ need to walk and object hierarchy. In the past I’ve had a number of ReflectionUtils that used string based expressions… >>> More
The dynamic Type in C# Simplifies COM Member Access from Visual FoxPro

as seen on West-Wind - Search for 'West-Wind'
I’ve written quite a bit about Visual FoxPro interoperating with .NET in the past both for ASP.NET interacting with Visual FoxPro COM objects as well as Visual FoxPro calling into .NET code via COM Interop. COM Interop with Visual FoxPro has a number of problems but one of them at least got a lot… >>> More
Finding a Relative Path in .NET

as seen on West-Wind - Search for 'West-Wind'
Here’s a nice and simple path utility that I’ve needed in a number of applications: I need to find a relative path based on a base path. So if I’m working in a folder called c:\temp\templates\ and I want to find a relative path for c:\temp\templates\subdir\test.txt I want to receive back subdir\test… >>> More

Related posts about visual-studio-2010

La version gratuite de Visual Studio 2010 est disponible, Visual Studio 2010 Express introduit des o

as seen on Developper.com - Search for 'Developper.com'
Visual Studio 2010 Express est disponible La version gratuite de Visual Studio 2010 propose à présent des outils de développement pour Windows Phone 7 Alors que Visual Studio 2010 débarque avec ses nouveautés (lire par ailleurs ici), sa version gratuite Visual Studio Express 2010 vient d'être… >>> More
Are Visual Studio 2010 Professional Solutions/Projects 100% compatible with Visual Studio 2010 Premi

as seen on Stack Overflow - Search for 'Stack Overflow'
I am just wondering on what version of Visual Studio 2010 to install (Professional or Premium) If there are a few people in the team with a mix of VS2010 professional/premium, would opening solution/project files be an issue, ie incorrect version or prompts to upgrade prjects.. Projects include:… >>> More
[ASP.NET 4.0] Persisting Row Selection in Data Controls

as seen on ASP.net Weblogs - Search for 'ASP.net Weblogs'
Data Control Selection Feature In ASP.NET 2.0: ASP.NET Data Controls row selection feature was based on row index (in the current page), this of course produce an issue if you try to select an item in the first page then navigate to the second page without select any record you will find the same… >>> More
Entity Framework Code-First to Provide Replacement for ASP.NET Profile Provider

as seen on ASP.net Weblogs - Search for 'ASP.net Weblogs'
A while back, I coordinated a project to add support for the SQL Table Profile Provider in ASP.NET 4 Web Applications. We urged Microsoft to improve ASP.NET’s built-in Profile support so our workaround wouldn’t be necessary. Instead, Microsoft plans to provide a replacement for ASP.NET Profile… >>> More
Tip#102: Did you know… How to specify tag specific formatting

as seen on ASP.net Weblogs - Search for 'ASP.net Weblogs'
Let’s see this with an example. I have the following html code on my page. Now if I format the document by selecting Edit –> Format document (or Ctrl K, Ctrl D) The document becomes I want the content inside td should remain on the same line Read More......(read more) >>> More