System.JSON.Writers.TJsonTextWriter.WriteComment

• Übergeordnet: TJsonTextWriter

Delphi

procedure WriteComment(const Comment: string); override;

C++

virtual void __fastcall WriteComment(const System::UnicodeString Comment);

Eigenschaften

Typ	Sichtbarkeit	Quelle	Unit	Übergeordnet
procedure function	public	System.JSON.Writers.pas System.JSON.Writers.hpp	System.JSON.Writers	TJsonTextWriter

Beschreibung

Schreibt einen Kommentar mit dem angegebenen Text.

Parameter:

• Comment: Der Text, der als Kommentar in den JSON-Daten angezeigt werden soll.

Das folgende Codefragment illustriert die Verwendung von WriteComment:

  Writer.WriteStartObject;
  Writer.WritePropertyName('colors');
  Writer.WriteStartArray;
  Writer.WriteStartObject;
  Writer.WriteComment('Hexadecimal value for the red color');
  Writer.WritePropertyName('name');
  Writer.WriteValue('red');
  Writer.WritePropertyName('hex');
  Writer.WriteValue('#f00');
  Writer.WriteEndObject;
  Writer.WriteEndArray;

{
  "colors": [
    {
      /*Hexadecimal value for the red color*/
      "name": "red",
      "hex": "#f00"
    }
  ]
}

Siehe auch

• JSON Writer (Beispiel)
• JSON Workbench (Beispiel)