在Visual Studio 2010中记录（XML）应用程序设置 [英] Documenting (XML) Application Settings in Visual Studio 2010

问题描述

我最近用Visual Studio（2010）创建了一个（C＃）项目，并使用了一些设置（我在属性下创建）。

我找到的唯一的地方我可以为我的文档添加一些XML注释，将在Settings.Designer.cs中。
但是这个文件是自动生成的，所以每当我更改设置时，评论都会消失。

即使Visual Studio也可以开始给出评论，缺少XML注释为了宣传可见的类型或成员....

我的问题是：
什么是最简单的方法来添加XML注释到我的设置？ p>

• 有没有比Settings.Designer.cs更好的地方？


• 我应该停止自动生成文件吗？如何？


• 任何其他方式？

我正在使用Sandcastle帮助文件生成器方式

解决方案

如果您打开设置（使用默认设计器），可以在属性窗口属性Description中找到。填写它，它将被用作自动生成文件中的XML注释摘要。

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

解决方案

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.

这篇关于在Visual Studio 2010中记录（XML）应用程序设置的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！