我最近使用Visual Studio（2010）创建了一个（C＃）项目并使用了一些设置（我在属性下创建）。
我找到的唯一可以在我的文档中添加XML注释的地方是Settings.Designer.cs。 但是这个文件是自动生成的，所以每当我更改设置时，评论都会消失。
即使是Visual Studio也开始提供mewarnings，“缺少XML评论的宣传明显是类型或成员....”
我的问题是： 将XML注释添加到我的设置的最佳方法是什么？
我正在使用Sandcastle帮助文件生成器
答案 0 :(得分：10)
如果您打开设置（使用默认设计器），则可以在属性窗口中找到属性“描述”。填写它，它将在自动生成的文件中用作XML注释摘要。
答案 1 :(得分：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元素的属性，如果您更改设计器中的设置将保留该属性，将保留该属性。但是，如果将其设置为Setting元素的子元素，则会将其删除。
答案 2 :(得分：0)
做到了。 我还不确定是否有更好的方法， 但我在Sandcastle HFB项目中添加了一个SettingsDoc.xml。 缺点是它不会被visual studio编译，所以我需要自己更新和检查引用等。