File tree Expand file tree Collapse file tree 1 file changed +84
-0
lines changed
Expand file tree Collapse file tree 1 file changed +84
-0
lines changed Original file line number Diff line number Diff line change 1+
2+ Transpilers/Help.psx.ps1
3+ ------------------------
4+ ### Synopsis
5+ Help Transpiler
6+
7+ ---
8+ ### Description
9+
10+ The Help Transpiler allows you to write inline help without directly writing comments.
11+
12+ ---
13+ ### Examples
14+ #### EXAMPLE 1
15+ ``` PowerShell
16+ {
17+ [Help(Synopsis="The Synopsis", Description="A Description")]
18+ param()
19+ ```
20+ "This Script Has Help, Without Directly Writing Comments"
21+
22+ } | .>PipeScript
23+ #### EXAMPLE 2
24+ ``` PowerShell
25+ {
26+ param(
27+ [Help(Synopsis="X Value")]
28+ $x
29+ )
30+ } | .>PipeScript
31+ ```
32+
33+ #### EXAMPLE 3
34+ ``` PowerShell
35+ {
36+ param(
37+ [Help("X Value")]
38+ $x
39+ )
40+ } | .>PipeScript
41+ ```
42+
43+ ---
44+ ### Parameters
45+ #### ** Synopsis**
46+
47+ | Type | Requried| Postion| PipelineInput|
48+ | --------------| --------| -------| -------------|
49+ | ``` [String] ``` | true | 1 | false |
50+ ---
51+ #### ** Description**
52+
53+ | Type | Requried| Postion| PipelineInput|
54+ | --------------| --------| -------| -------------|
55+ | ``` [String] ``` | false | named | false |
56+ ---
57+ #### ** Example**
58+
59+ | Type | Requried| Postion| PipelineInput|
60+ | ----------------| --------| -------| -------------|
61+ | ``` [String[]] ``` | false | named | false |
62+ ---
63+ #### ** Link**
64+
65+ | Type | Requried| Postion| PipelineInput|
66+ | ----------------| --------| -------| -------------|
67+ | ``` [String[]] ``` | false | named | false |
68+ ---
69+ #### ** ScriptBlock**
70+
71+ | Type | Requried| Postion| PipelineInput |
72+ | -------------------| --------| -------| --------------|
73+ | ``` [ScriptBlock] ``` | false | named | true (ByValue)|
74+ ---
75+ ### Syntax
76+ ``` PowerShell
77+ Transpilers/Help.psx.ps1 [-Synopsis] <String> [-Description <String>] [-Example <String[]>] [-Link <String[]>] [<CommonParameters>]
78+ ```
79+ ``` PowerShell
80+ Transpilers/Help.psx.ps1 [-Synopsis] <String> [-Description <String>] [-Example <String[]>] [-Link <String[]>] [-ScriptBlock <ScriptBlock>] [<CommonParameters>]
81+ ```
82+ ---
83+
84+
You can’t perform that action at this time.
0 commit comments