-
-
Save crowsdev/055e33edf0afb14eb72bba1b97d62bdd to your computer and use it in GitHub Desktop.
C# XML Documentation Tag Snippets for Visual Studio Code
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// See: https://code.visualstudio.com/docs/editor/userdefinedsnippets#_create-your-own-snippets | |
{ | |
"summary": { | |
"prefix": [ | |
"summary", | |
"<summary" | |
], | |
"body": [ | |
"/// <summary>", | |
"///", | |
"/// </summary>" | |
], | |
"description": "Summary XML tag" | |
}, | |
"c": { | |
"prefix": [ | |
"c", | |
"<c" | |
], | |
"body": "<c>$0</c>", | |
"description": "Code inside a XML tag" | |
}, | |
"code": { | |
"prefix": [ | |
"code", | |
"<code" | |
], | |
"body": [ | |
"/// <code>", | |
"/// $0", | |
"/// </code>" | |
], | |
"description": "Code XML tag" | |
}, | |
"example": { | |
"prefix": [ | |
"example", | |
"<example" | |
], | |
"body": [ | |
"/// <example>", | |
"/// $0", | |
"/// </example>" | |
], | |
"description": "example XML tag" | |
}, | |
"exception": { | |
"prefix": [ | |
"exception", | |
"<exception" | |
], | |
"body": "/// <exception cref=\"${0:exception}\">${1:description}</exception>", | |
"description": "Exception XML tag" | |
}, | |
"list": { | |
"prefix": [ | |
"list", | |
"<list" | |
], | |
"body": [ | |
"/// <list type=\"${type}\">", | |
"/// <listheader>", | |
"/// <term>$0</term>", | |
"/// <description>$1</description>", | |
"/// </listheader>", | |
"/// </list>" | |
], | |
"description": "List XML tag" | |
}, | |
"listitem": { | |
"prefix": [ | |
"listitem", | |
"<listitem" | |
], | |
"body": [ | |
"/// <item>", | |
"/// <term>$0</term>", | |
"/// <description>$1</description>", | |
"/// </item>" | |
], | |
"description": "List XML tag" | |
}, | |
"para": { | |
"prefix": [ | |
"para", | |
"<para" | |
], | |
"body": "<para>$0</para>", | |
"description": "Paragraph inside a XML tag" | |
}, | |
"param": { | |
"prefix": [ | |
"param", | |
"<param" | |
], | |
"body": "/// <param name=\"${0:name}\">${1:description}</param>", | |
"description": "Parameter XML tag" | |
}, | |
"paramref": { | |
"prefix": [ | |
"paramref", | |
"<paramref" | |
], | |
"body": "<paramref=\"$0\"/>", | |
"description": "Parameter reference inside a XML tag" | |
}, | |
"remarks": { | |
"prefix": [ | |
"remarks", | |
"<remarks" | |
], | |
"body": "/// <remarks>$0</remarks>", | |
"description": "Remarks XML tag" | |
}, | |
"return": { | |
"prefix": [ | |
"return", | |
"<return" | |
], | |
"body": "/// <returns>$0</returns>", | |
"description": "Returns XML tag" | |
}, | |
"see": { | |
"prefix": [ | |
"see", | |
"<see" | |
], | |
"body": "<see cref=\"$0\"/>", | |
"description": "Link to a code element inside a XML tag" | |
}, | |
"seealso": { | |
"prefix": [ | |
"seealso", | |
"<seealso" | |
], | |
"body": "<seealso cref=\"$0\"/>", | |
"description": "Link to a class inside a XML tag" | |
}, | |
"value": { | |
"prefix": [ | |
"value", | |
"<value" | |
], | |
"body": "/// <value>$0</value>", | |
"description": "Value XML tag" | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment