评论 .json 配置文件

Question

我一直在研究 ASPNET 5 和 MVC6。与以前版本相比的一个主要变化是，在新版本中，许多配置文件是 .json 而不是 .xml。

麻烦有两个方面：

1. 配置文件通常需要 cmets 以实现可维护性和调试（例如，在修改配置时注释掉原始行，以便在更改效果不佳时轻松返回原始行。）
2. .json 不支持 cmets，除非通过 hack。有numerous hack 可以在 JSON 中添加评论支持，很多都提到了here。但是，对于应该使用哪种 hack 来保持代码的可读性、可维护性以及（希望）与 Visual Studio 的工具兼容，并没有多少标准。

如果每个开发者都选择自己的评论技巧，或者干脆停止将可读性 cmets 添加到配置文件中，这将是开发者体验的一大退步。此外，Visual Studio 具有注释/取消注释快捷方式，适用于支持许多开发人员在开发和调试周期中大量使用的 cmets 的所有语言。开发世界不需要另一个“不要忘记在这种情况下常规的东西不起作用，你需要做另一件事。”

对于使用 Visual Studio 和 MS 工具链将 cmets 侵入 .json 配置文件的哪种方法是“最佳”的，是否有任何 Microsoft（或类似的）指南？

Answer 1

dotnet 核心中的标准 AddJsonFile 配置扩展允许 JSON 中的 cmets 和尾随逗号：https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.Extensions.Configuration.Json/src/JsonConfigurationFileParser.cs#L26-L27

您也可以在自己的 JSON 解析中进行配置：https://docs.microsoft.com/en-us/dotnet/standard/serialization/system-text-json-invalid-json?pivots=dotnet-core-3-1