Visual Studio 2010中的应用程序设置文档（XML）

我最近使用Visual Studio（2010）创建了一个（C＃）项目，并使用了一些设置（我在属性下创建）。Visual Studio 2010中的应用程序设置文档（XML）

我发现可以在我的文档中添加一些XML注释的唯一地方是Settings.Designer.cs。但是这个文件是自动生成的，所以每当我改变设置时，注释都不见了。

即使Visual Studio中给出开始给mewarnings，“缺少XML注释进行宣传明显类型或成员......”

我的问题这里：什么是XML注释添加到我的设置最巧妙的方法？

有没有比Settings.Designer.cs更好的地方？
我应该停止自动生成文件吗？怎么样？
还有其他方法吗？

我使用的沙堡帮助文件生成器的方式

来源

2010-05-11 SirLenz0rlot

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

来源

2010-09-22 06:50:32 veselka

我无法检查出来，但谢谢。这个问题发布了很长时间，但将来会尝试。谢谢 – SirLenz0rlot 2010-09-22 11:52:31

我也无法找到它。但我认为你所说的是“资源”，这与设置不同。 – Gqqnbig 2012-08-08 01:01:17

只是想指出，您必须选择有问题的设置才能从属性窗口编辑其描述。 – 2014-07-14 08:08:42

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

来源

2010-05-25 12:59:54 SirLenz0rlot

在你的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元素的属性，那么如果您在设计器中更改设置，则该属性将被保留。但是，如果您将其设置为Setting元素的子元素，它将被删除。

来源

2012-12-13 20:51:56 laurian

Visual Studio 2010中的应用程序设置文档（XML）

回答

相关问题