我正在使用 Visual Studio 2010 中的设置编辑器从 .NET 4 web.config 文件的部分添加/编辑/删除我的设置。
这是一个(相当模糊的)示例摘录来说明我的意思:
<applicationSettings>
<Animals.My.MySettings>
<!-- Specify the type of animal this website is dedicated to... -->
<setting name="AnimalType" serializeAs="String">
<value>Monkey</value>
</setting>
</Animals.My.MySettings>
</applicationSettings>
在上面的示例中,注释对于在现场手动编辑配置文件的任何人都是有用的(例如,一旦 Web 应用程序已部署到客户站点)。但是,如果我使用 VS 设置编辑器,那么每当我添加/编辑/删除设置时,注释都会丢失。
到目前为止,我想出了以下解决方法:
我可以选择从不使用 VS 设置编辑器,但我必须告诉我的团队也避免使用它,而且总是有一次有人忘记了我们失去了所有的评论......
我可以保留一份单独的 web.config 副本,其中包含一堆注释。然后我们将应用程序与配置文件的副本一起发送......(我不喜欢这个想法,因为这意味着我必须记住保持第二个副本是最新的并且我必须记住切换发布时的配置文件...太多要记住;太多可能会出错)。
在开始标签上方添加评论似乎没问题,所以我可以将所有评论放在顶部。
我的问题是:解决这个问题的最佳方法是什么?你有什么建议吗?