评论 .json 配置文件
Commenting .json config files
我一直在深入研究 ASPNET 5 和 MVC6。与之前版本的一个主要变化是，在新版本中，许多配置文件是.json 而不是.xml。
麻烦是双重的：
- 配置文件通常需要注释以维护和调试（例如，在修改配置时注释掉原始行，以便在更改效果不佳时轻松返回到原始行。）
- .json 不支持评论，除非通过 hack。有numerous hacks to add comment support into JSON, many are mentioned here。但是，对于应该使用哪种 hack 来保持代码的可读性、可维护性以及（希望）与 Visual Studio.
的工具兼容，并没有太多的标准。
如果每个开发人员都选择自己的评论技巧，或者干脆停止将可读性评论添加到配置文件中，那将是开发人员体验的一大倒退。此外，Visual Studio 有 comment/uncomment 快捷键，适用于所有支持注释的语言，许多开发人员在开发和调试周期中大量使用这些注释。开发世界不需要另一个 "Don't forget that in this one situation that the regular stuff doesn't work and you need to do this other thing."
Microsoft（或类似的）是否有任何关于使用 Visual Studio 和 MS 工具链将评论侵入 .json 配置文件的方法 "best" 的指南？
dotnet 核心中的标准 AddJsonFile 配置扩展允许 JSON 中的注释和尾随逗号：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
我一直在深入研究 ASPNET 5 和 MVC6。与之前版本的一个主要变化是，在新版本中，许多配置文件是.json 而不是.xml。
麻烦是双重的：
- 配置文件通常需要注释以维护和调试（例如，在修改配置时注释掉原始行，以便在更改效果不佳时轻松返回到原始行。）
- .json 不支持评论，除非通过 hack。有numerous hacks to add comment support into JSON, many are mentioned here。但是，对于应该使用哪种 hack 来保持代码的可读性、可维护性以及（希望）与 Visual Studio. 的工具兼容，并没有太多的标准。
如果每个开发人员都选择自己的评论技巧，或者干脆停止将可读性评论添加到配置文件中，那将是开发人员体验的一大倒退。此外，Visual Studio 有 comment/uncomment 快捷键，适用于所有支持注释的语言，许多开发人员在开发和调试周期中大量使用这些注释。开发世界不需要另一个 "Don't forget that in this one situation that the regular stuff doesn't work and you need to do this other thing."
Microsoft（或类似的）是否有任何关于使用 Visual Studio 和 MS 工具链将评论侵入 .json 配置文件的方法 "best" 的指南？
dotnet 核心中的标准 AddJsonFile 配置扩展允许 JSON 中的注释和尾随逗号：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