JsonDocumentOptions.CommentHandling Property

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Package:

System.Text.Json v9.0.0-rc.2.24473.5

Source:

JsonDocumentOptions.cs

Gets or sets a value that determines how the JsonDocument handles comments when reading through the JSON data.

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

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

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

Public Property CommentHandling As JsonCommentHandling

Property Value

JsonCommentHandling

One of the enumeration values that indicates how comments are handled.

Exceptions

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 if a comment is encountered.