JsonSerializerOptions.ReadCommentHandling Property

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Package:

System.Text.Json v9.0.0-preview.3.24172.9

Source:

JsonSerializerOptions.cs

Gets or sets a value that defines how comments are handled during deserialization.

public:
 property System::Text::Json::JsonCommentHandling ReadCommentHandling { System::Text::Json::JsonCommentHandling get(); void set(System::Text::Json::JsonCommentHandling value); };

public System.Text.Json.JsonCommentHandling ReadCommentHandling { get; set; }

member this.ReadCommentHandling : System.Text.Json.JsonCommentHandling with get, set

Public Property ReadCommentHandling As JsonCommentHandling

Property Value

JsonCommentHandling

A value that indicates whether comments are allowed, disallowed, or skipped.

Exceptions

InvalidOperationException

This property was set after serialization or deserialization has occurred.

ArgumentOutOfRangeException

The comment handling enum is set to a value that is not supported (or not within the JsonCommentHandling enum range).

Remarks

By default, a JsonException is thrown during deserialization if a comment is encountered.

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