注释 .json 配置文件

Question

我一直在深入研究 ASPNET 5 和 MVC6。与之前版本的一个主要变化是，在新版本中，很多配置文件都是.json而不是.xml。

麻烦有两个：

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

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

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

Answer 1

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

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