Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Snippets section is added to package.json #55

Closed
wants to merge 1 commit into from
Closed

Snippets section is added to package.json #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"displayName": "C# XML Documentation Comments",
"description": "Generate C# XML documentation comments for ///",
"categories": [
"Other"
"Other",
"Snippets"
],
"galleryBanner": {
"color": "#4F87FF",
Expand All @@ -26,7 +27,13 @@
"description": "Press the Enter key to activate a command."
}
}
}
},
"snippets": [
{
"language": "csharp",
"path": "./snippets/csharp.json"
}
]
},
"activationEvents": [
"onLanguage:csharp"
Expand Down
38 changes: 19 additions & 19 deletions snippets/csharp.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,93 +1,93 @@
{
".source.charp": {
".source.csharp": {
"c": {
"prefix": "<c>",
"body": [ "<c>${text}</c>"],
"body": [ "<c>${1:text}</c>"],
"description": "The <c> tag gives you a way to indicate that text within a description should be marked as code.Use <code> to indicate multiple lines as code."
},
"code": {
"prefix": "<code>",
"body": [ "<code>${content}</code>"],
"body": [ "<code>${1:content}</code>"],
"description": "The <code> tag gives you a way to indicate multiple lines as code.Use <c> to indicate that text within a description should be marked as code."
},
"example": {
"prefix": "<example>",
"body": [ "<example>${description}</example>"],
"body": [ "<example>${1:description}</example>"],
"description": "The <example> tag lets you specify an example of how to use a method or other library member.This commonly involves using the <code> tag."
},
"exception": {
"prefix": "<exception>",
"body": [ "<exception cref=\"${member}\">${description}</exception>"],
"body": [ "<exception cref=\"${1:member}\">${2:description}</exception>"],
"description": "The <exception> tag lets you specify which exceptions can be thrown.This tag can be applied to definitions for methods, properties, events, and indexers."
},
"include": {
"prefix": "<include>",
"body": [ "<include file='${filename}' path='${tagpath}[@name=\"${id}\"]' />"],
"body": [ "<include file='${1:filename}' path='${2:tagpath}[@name=\"${3:id}\"]' />"],
"description": "The <include> tag lets you refer to comments in another file that describe the types and members in your source code."
},
"list": {
"prefix": "<list>",
"body": [ "<list type=\"${bullet}\"></list>"],
"body": [ "<list type=\"${1:bullet}\"></list>"],
"description": "The <listheader> 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": "<para>",
"body": [ "<para>${content}</para>"],
"body": [ "<para>${1:content}</para>"],
"description": "The <para> tag is for use inside a tag, such as <summary>, <remarks>, or <returns>, and lets you add structure to the text."
},
"param": {
"prefix": "<param>",
"body": [ "<param name=\"${name}\">${description}</param>"],
"body": [ "<param name=\"${1:name}\">${2:description}</param>"],
"description": "The <param> 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 <param> tags."
},
"paramref": {
"prefix": "<paramref>",
"body": [ "<paramref name=\"${name}\"/>"],
"body": [ "<paramref name=\"${1:name}\"/>"],
"description": "The <paramref> tag gives you a way to indicate that a word in the code comments, for example in a <summary> or <remarks> block refers to a parameter."
},
"permission": {
"prefix": "<permission>",
"body": [ "<permission cref=\"${member}\">${description}</permission>"],
"body": [ "<permission cref=\"${1:member}\">${2:description}</permission>"],
"description": "The <permission> tag lets you document the access of a member.The PermissionSet class lets you specify access to a member."
},
"remarks": {
"prefix": "<remarks>",
"body": [ "<remarks>${description}</remarks>"],
"body": [ "<remarks>${1:description}</remarks>"],
"description": "The <remarks> tag is used to add information about a type, supplementing the information specified with <summary>."
},
"returns": {
"prefix": "<returns>",
"body": [ "<returns>${description}</returns>"],
"body": [ "<returns>${1:description}</returns>"],
"description": "The <returns> tag should be used in the comment for a method declaration to describe the return value."
},
"see": {
"prefix": "<see>",
"body": [ "<see cref=\"${member}\"/>"],
"body": [ "<see cref=\"${1:member}\"/>"],
"description": "The <see> tag lets you specify a link from within text.Use <seealso> to indicate that text should be placed in a See Also section."
},
"seealso": {
"prefix": "<seealso>",
"body": [ "<seealso cref=\"${member}\"/>"],
"body": [ "<seealso cref=\"${1:member}\"/>"],
"description": "The <seealso> tag lets you specify the text that you might want to appear in a See Also section.Use <see> to specify a link from within text."
},
"summary": {
"prefix": "<summary>",
"body": [ "<summary>${description}</summary>"],
"body": [ "<summary>${1:description}</summary>"],
"description": "The <summary> tag should be used to describe a type or a type member.Use <remarks> to add supplemental information to a type description."
},
"typeparam": {
"prefix": "<typeparam>",
"body": [ "<typeparam name=\"${name}\">${description}</typeparam>"],
"body": [ "<typeparam name=\"${1:name}\">${2:description}</typeparam>"],
"description": "The <typeparam> tag should be used in the comment for a generic type or method declaration to describe a type parameter."
},
"typeparamref": {
"prefix": "<typeparamref>",
"body": [ "<typeparamref name=\"${name}\"/>"],
"body": [ "<typeparamref name=\"${1:name}\"/>"],
"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": "<value>",
"body": [ "<value>${property-description}</value>"],
"body": [ "<value>${1:property-description}</value>"],
"description": "The <value> tag lets you describe the value that a property represents."
}
}
Expand Down