JsonCommentHandling Enum

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Defines how the Utf8JsonReader struct handles comments.

C#

public enum JsonCommentHandling

Inheritance

Object

ValueType

Enum

JsonCommentHandling

Fields

Name	Value	Description
Disallow	0	Doesn't allow comments within the JSON input. Comments are treated as invalid JSON if found, and a JsonException is thrown. This is the default value.
Skip	1	Allows comments within the JSON input and ignores them. The Utf8JsonReader behaves as if no comments are present.
Allow	2	Allows comments within the JSON input and treats them as valid tokens. While reading, the caller can access the comment values.

Remarks

For more information, see How to allow some kinds of invalid JSON with System.Text.Json.

Applies to