Skip to content

Silencing JSON comment errors #34825

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
guardrex merged 3 commits into from
Feb 27, 2025
Merged

Silencing JSON comment errors #34825

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8fe372b
Silencing JSON comment errors
guardrex Feb 27, 2025
32b0288
Updates
guardrex Feb 27, 2025
69b199c
Updates
guardrex Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions aspnetcore/fundamentals/configuration/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,16 @@ Using the [default](#default) configuration, the `appsettings.json` and `appsett

Comments in `appsettings.json` and `appsettings.{Environment}.json` files are supported using JavaScript or [C# style comments](/dotnet/csharp/language-reference/tokens/comments).

Some integrated development environments (IDE) display errors when editing a JSON file that contains comments. Often, the errors can be disabled with a setting in the IDE. In Visual Studio Code, for example, add the following to the `settings.json` file to disable the errors:

```json
"files.associations": {
"appsettings*.json": "jsonc"
}
```

For other IDEs, check the tool's documentation and other product support channels to determine how to silence the errors.

<a name="optpat"></a>

### Bind hierarchical configuration data using the options pattern
Expand Down