-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathComment Based Help.snippet
121 lines (110 loc) · 3.23 KB
/
Comment Based Help.snippet
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
<CodeSnippet Format="1.0.0">
<Header>
<Title>Comment Based Help</Title>
<Shortcut>commenthelp</Shortcut>
<Description>Code snippet for creating new comment based help</Description>
<Author>SAPIEN Technologies, Inc.</Author>
<SnippetTypes>
<SnippetType>Expansion</SnippetType>
</SnippetTypes>
</Header>
<Snippet>
<Declarations>
<Literal Editable="True">
<ID>synopsis</ID>
<ToolTip>A brief description of the function.</ToolTip>
<Function></Function>
<Default>Description of the function.</Default>
</Literal>
<Literal Editable="True">
<ID>description</ID>
<ToolTip>A detailed description of the function.</ToolTip>
<Function></Function>
<Default>A detailed description of the function.</Default>
</Literal>
<Literal Editable="True">
<ID>parameterADescription</ID>
<ToolTip>The description of a parameter.</ToolTip>
<Function></Function>
<Default>The description of the ParameterA parameter.</Default>
</Literal>
<Literal Editable="True">
<ID>parameterBDescription</ID>
<ToolTip>The description of a parameter.</ToolTip>
<Function></Function>
<Default>The description of the ParameterB parameter.</Default>
</Literal>
<Literal Editable="True">
<ID>firstExample</ID>
<ToolTip>A an example with an optional description.</ToolTip>
<Function></Function>
<Default>Get-Something -ParameterA 'One value' -ParameterB 32</Default>
</Literal>
<Literal Editable="True">
<ID>secondExample</ID>
<ToolTip>An example with an optional description.</ToolTip>
<Function></Function>
<Default>Get-Something 'One value' 32</Default>
</Literal>
<Literal Editable="True">
<ID>inputs</ID>
<ToolTip>A comma-delimited list of input types.</ToolTip>
<Function></Function>
<Default>System.String,System.Int32</Default>
</Literal>
<Literal Editable="True">
<ID>outputs</ID>
<ToolTip>A comma-delimited list of output types.</ToolTip>
<Function></Function>
<Default>System.String</Default>
</Literal>
<Literal Editable="True">
<ID>notes</ID>
<ToolTip>Notes about the function.</ToolTip>
<Function></Function>
<Default>Additional information about the function go here.</Default>
</Literal>
<Literal Editable="True">
<ID>firstLink</ID>
<ToolTip>A link to a related help topic or command.</ToolTip>
<Function></Function>
<Default>about_functions_advanced</Default>
</Literal>
<Literal Editable="True">
<ID>secondLink</ID>
<ToolTip>A link to a related help topic or command.</ToolTip>
<Function></Function>
<Default>about_comment_based_help</Default>
</Literal>
</Declarations>
<Code Language="powershell">
<![CDATA[<#
.SYNOPSIS
$synopsis$
.DESCRIPTION
$description$
.PARAMETER ParameterA
$parameterADescription$
.PARAMETER ParameterB
$parameterBDescription$
.EXAMPLE
$firstExample$
.EXAMPLE
$secondExample$
.INPUTS
$inputs$
.OUTPUTS
$outputs$
.NOTES
$notes$
.LINK
$firstLink$
.LINK
$secondLink$
#>
$end$]]>
</Code>
</Snippet>
</CodeSnippet>
</CodeSnippets>