This key defines the character that can be placed before a string boundary to escape it when parsing snippet parameters.
The value is a string that specifies the escape character. If required, this will usually be \.
Appears in#
└── Snippet Format
└── string_escape_characterType#
string
Examples#
In this example, we have configured string escape character to use a backslash.
Copied to clipboard
_snippets:
example:
snippet: <<example [[param]]>>
params:
param:
parser: argument
options:
format:
string_escape_character: \\{
"_snippets": {
"example": {
"snippet": "<<example [[param]]>>",
"params": {
"param": {
"parser": "argument",
"options": {
"format": {
"string_escape_character": "\\\\"
}
}
}
}
}
}
}