8

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

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

甚至 Visual Studio 都开始给我警告，“缺少用于宣传的 XML 注释可见类型或成员....”

我的问题是：将 XML 注释添加到我的设置中的最佳方法是什么？

  • 还有比 Settings.Designer.cs 更好的地方吗？
  • 我应该停止自动生成文件吗？如何？
  • 还有什么办法吗？

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

4

3 回答 3

10

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

于 2010-09-22T06:50:32.800 回答
2

在您的 Settings.settings 文件中（不要使用设计器打开它），添加一个属性，例如“描述”：

<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 主题文件的工具。在项目的构建事件中调用该工具，然后瞧。

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

于 2012-12-13T20:51:56.860 回答
0

做到了。我仍然不确定是否有更好的方法，但我在我的 Sandcastle HFB 项目中添加了一个 SettingsDoc.xml。缺点是它没有被visual studio编译，所以我需要自己更新和检查引用等。

于 2010-05-25T12:59:54.377 回答