diff --git a/package.json b/package.json index bc000a9..f066b8f 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,8 @@ "displayName": "C# XML Documentation Comments", "description": "Generate C# XML documentation comments for ///", "categories": [ - "Other" + "Other", + "Snippets" ], "galleryBanner": { "color": "#4F87FF", @@ -26,7 +27,13 @@ "description": "Press the Enter key to activate a command." } } - } + }, + "snippets": [ + { + "language": "csharp", + "path": "./snippets/csharp.json" + } + ] }, "activationEvents": [ "onLanguage:csharp" diff --git a/snippets/csharp.json b/snippets/csharp.json index 69119de..a244ca7 100644 --- a/snippets/csharp.json +++ b/snippets/csharp.json @@ -1,93 +1,93 @@ { - ".source.charp": { + ".source.csharp": { "c": { "prefix": "", - "body": [ "${text}"], + "body": [ "${1:text}"], "description": "The tag gives you a way to indicate that text within a description should be marked as code.Use to indicate multiple lines as code." }, "code": { "prefix": "", - "body": [ "${content}"], + "body": [ "${1:content}"], "description": "The tag gives you a way to indicate multiple lines as code.Use to indicate that text within a description should be marked as code." }, "example": { "prefix": "", - "body": [ "${description}"], + "body": [ "${1:description}"], "description": "The tag lets you specify an example of how to use a method or other library member.This commonly involves using the tag." }, "exception": { "prefix": "", - "body": [ "${description}"], + "body": [ "${2:description}"], "description": "The tag lets you specify which exceptions can be thrown.This tag can be applied to definitions for methods, properties, events, and indexers." }, "include": { "prefix": "", - "body": [ ""], + "body": [ ""], "description": "The tag lets you refer to comments in another file that describe the types and members in your source code." }, "list": { "prefix": "", - "body": [ ""], + "body": [ ""], "description": "The block is used to define the heading row of either a table or definition list.When defining a table, you only need to supply an entry for term in the heading." }, "para": { "prefix": "", - "body": [ "${content}"], + "body": [ "${1:content}"], "description": "The tag is for use inside a tag, such as , , or , and lets you add structure to the text." }, "param": { "prefix": "", - "body": [ "${description}"], + "body": [ "${2:description}"], "description": "The tag should be used in the comment for a method declaration to describe one of the parameters for the method.To document multiple parameters, use multiple tags." }, "paramref": { "prefix": "", - "body": [ ""], + "body": [ ""], "description": "The tag gives you a way to indicate that a word in the code comments, for example in a or block refers to a parameter." }, "permission": { "prefix": "", - "body": [ "${description}"], + "body": [ "${2:description}"], "description": "The tag lets you document the access of a member.The PermissionSet class lets you specify access to a member." }, "remarks": { "prefix": "", - "body": [ "${description}"], + "body": [ "${1:description}"], "description": "The tag is used to add information about a type, supplementing the information specified with ." }, "returns": { "prefix": "", - "body": [ "${description}"], + "body": [ "${1:description}"], "description": "The tag should be used in the comment for a method declaration to describe the return value." }, "see": { "prefix": "", - "body": [ ""], + "body": [ ""], "description": "The tag lets you specify a link from within text.Use to indicate that text should be placed in a See Also section." }, "seealso": { "prefix": "", - "body": [ ""], + "body": [ ""], "description": "The tag lets you specify the text that you might want to appear in a See Also section.Use to specify a link from within text." }, "summary": { "prefix": "", - "body": [ "${description}"], + "body": [ "${1:description}"], "description": "The tag should be used to describe a type or a type member.Use to add supplemental information to a type description." }, "typeparam": { "prefix": "", - "body": [ "${description}"], + "body": [ "${2:description}"], "description": "The tag should be used in the comment for a generic type or method declaration to describe a type parameter." }, "typeparamref": { "prefix": "", - "body": [ ""], + "body": [ ""], "description": "Use this tag to enable consumers of the documentation file to format the word in some distinct way, for example in italics." }, "value": { "prefix": "", - "body": [ "${property-description}"], + "body": [ "${1:property-description}"], "description": "The tag lets you describe the value that a property represents." } }