JsonTextWriter.WriteCommentAsync Method (original) (raw)

	JsonTextWriterWriteCommentAsync Method

Asynchronously writes a comment /*...*/ containing the specified text.

Namespace: Newtonsoft.Json
Assembly: Newtonsoft.Json (in Newtonsoft.Json.dll) Version: 12.0.1+509643a8952ce731e0207710c429ad6e67dc43db

Syntax

public override Task WriteCommentAsync( string text, CancellationToken cancellationToken = null )

Parameters

text

Type: SystemString
Text to place inside the comment.

cancellationToken (Optional)

Type: System.ThreadingCancellationToken
The token to monitor for cancellation requests. The default value is None.

Return Value

Type: Task
A Task that represents the asynchronous operation.

Remarks

Derived classes must override this method to get asynchronous behaviour. Otherwise it will execute synchronously, returning an already-completed task.

See Also

Reference