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

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

在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_。

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

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