Visual Studio 2010の設定エディターを使用して、.NET4web.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の別のコピーを保持することができます。次に、構成ファイルのコピーを使用してアプリケーションを出荷します...(2番目のコピーを最新の状態に保つことを忘れないでください。また、切り替えることを忘れないでください。このアイデアは好きではありません。リリース時の設定ファイル...覚えておくべきことが多すぎます。多すぎるとうまくいかない可能性があります)。
開始タグの上にコメントを追加しても問題ないように思われるので、すべてのコメントを一番上に置くことができます。
私の質問は:この問題を回避するための最良の方法は何ですか?おすすめは何ですか?