代码之家 › 专栏 › 技术社区 › Len Tango Ben

在Visual Studio 2010中记录(XML)应用程序设置

application-settings documentation visual-studio-2010 c#

8

Len Tango Ben · 技术社区 · 16 年前

我最近用Visual Studio(2010)创建了一个(c)项目,并使用了一些设置(这些设置是我在“属性”下创建的)。

我唯一能为文档添加一些XML注释的地方就是settings.designer.cs。但是,这个文件是自动生成的,所以每当我更改设置时,注释都会消失。

甚至Visual Studio也开始向MeWarnings发出警告:“缺少用于公开的XML注释,可见类型或成员….”

我的问题是: 在我的设置中添加XML注释的最新方法是什么?

有没有比settings.designer.cs更好的地方?
我应该停止自动生成文件吗?怎么用?
还有别的办法吗?

顺便说一下,我正在使用Sandcastle帮助文件生成器

3 回复 | 直到 16 年前

1

10

veselka 15 年前

如果打开设置(使用默认设计器),可以在属性窗口属性“说明”中找到。填写它,它将在自动生成的文件中用作XML注释摘要。

2

laurian 13 年前

在settings.settings文件中(不要用设计器打开),添加一个属性,例如“description”:

<Setting Name="MySetting" Description="This property does blah blah blah" Type="System.Int32" Scope="Application">
  <Value Profile="(Default)">42</Value>
</Setting>

这将产生

/// <summary>
/// This property does blah blah blah
/// </summary>
[global...]
public int MySetting { ...

您还可以构建一个获取settings.settings文件并创建MAML主题文件的工具。在项目的构建事件中调用该工具,然后voil_。

在我的测试中,如果您将描述作为设置元素的属性,那么如果您在设计器中更改设置,那么它将被保留。但是,如果将其作为设置元素的子级,它将被删除。

3

0

Len Tango Ben 16 年前

做到了。我仍然不确定是否有更好的方法, 但我在sandcastle hfb项目中添加了settingsdoc.xml。缺点是它不能被Visual Studio编译,所以我需要自己更新和检查引用等。