Escaping the $ character in snippets
Visual StudioCode SnippetsVisual Studio Problem Overview
I find myself doing a ton of jQuery these days, so I started to abstract out some of the common things I do into snippets. I look forward to sharing these with the community, but I'm running into an issue right now.
The literals in snippets are defined by adding dollar signs ($) around the name of the literal to delimit where the value you would like to provide will go. This is difficult because jQuery uses the dollar sign notation in order to use a lot of its functionality.
What is the escape sequence for snippets, so I am able to use the dollar sign, and have my snippets still function?
Visual Studio Solutions
Solution 1 - Visual Studio
To have a literal $
try doubling it: $$
Solution 2 - Visual Studio
This is the right way for Visual Studio Code: \\$
.
This makes the $
a literal part of the snippet rather than the start of a $
-prefixed construct.
Solution 3 - Visual Studio
There is an "Delimiter" attribute defined for a Code element. This defaults to $ but you can set it to a different character like ~ or so.
...
<Snippet>
<Code Language="JavaScript" Delimiter="~"><![CDATA[(function ($) {
$(document).ready(function () {
});
})(jQuery);]]></Code>
</Snippet>
...
Solution 4 - Visual Studio
Although the jQuery response is valid, it's a nicer syntax to use the $ notation.
I've found an answer: Making the $ character a literal with a default value of $.
<Literal Editable="true">
<ID>dollar</ID> <ToolTip>replace the dollar sign character</ToolTip> <Default>$</Default> <Function> </Function> </Literal>
Solution 5 - Visual Studio
I used this for a formattable string in C#. I used the example above from cory-fowler verbatim:
<Literal Editable="true">
<ID>dollar</ID>
<ToolTip>Replace the dollar sign character</ToolTip>
<Default>$</Default>
<Function></Function>
</Literal>
Usage (line breaks are added for clarity on Stack Overflow, not in the original.):
string errMessage = $dollar$"Error occurred in
{MethodBase.GetCurrentMethod().Module}, in procedure
{MethodBase.GetCurrentMethod().Name}: {ex.Message}".ToString();
Thanks, cory-fowler!
Solution 6 - Visual Studio
I found the above cory-fowler answer useful, but was frustrated that the literal $ was pre-selected when executing a C# snippet in VS 2019...
It was also ignoring my $end$ keyword...
<![CDATA[string Literal_edit_true = $dollar$"$end$";]]>
Simply changing to Editable=false
resolved the issue and now the cursor appears at $end$ ready to type...
<Snippet>
<Code Language="CSharp">
<![CDATA[string Literal_edit_false = $dollar$"$end$";]]>
</Code>
<Declarations>
<Literal Editable="false">
<ID>dollar</ID>
<ToolTip>Replace the dollar sign character</ToolTip>
<Default>$</Default>
<Function></Function>
</Literal>
</Declarations>
</Snippet>