Test-MarkdownCommandHelp
Testar strukturen för en Markdown-hjälpfil.
Syntax
Item
Test-MarkdownCommandHelp
[-Path] <string[]>
[-DetailView]
[<CommonParameters>]
Literal
Test-MarkdownCommandHelp
-LiteralPath <string[]>
[-DetailView]
[<CommonParameters>]
Beskrivning
Det här kommandot läser en Markdown-hjälpfil och validerar strukturen för hjälpinnehållet genom att söka efter nödvändiga element i rätt ordning. Kommandot returnerar $true om filen godkänns. Parametern DetailView kan användas för att visa mer detaljerad valideringsinformation.
Exempel
Exempel 1 – Testa en Markdown-hjälpfil
I det här exemplet testar vi strukturen för en Markdown-modulhjälpfil. Det här testet misslyckas eftersom kommandot förväntar sig att testa en Markdown-kommandohjälpfil. Utdata visar vilken typ av information du kan förvänta dig av parametern DetailView.
Test-MarkdownCommandHelp .\v2\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md -DetailView
Test-MarkdownCommandHelp
Valid: False
File: D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md
Messages:
PASS: First element is a thematic break
FAIL: SYNOPSIS not found.
FAIL: SYNTAX not found.
FAIL: DESCRIPTION not found.
FAIL: EXAMPLES not found.
FAIL: PARAMETERS not found.
FAIL: INPUTS not found.
FAIL: OUTPUTS not found.
FAIL: NOTES not found.
FAIL: RELATED LINKS not found.
Parametrar
-DetailView
Instruerar kommandot att mata ut detaljerad valideringsinformation.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | False |
| Stöder jokrar: | False |
| DontShow: | False |
Parametermängder
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter fastighetsnamn: | False |
| Värde från återstående argument: | False |
-LiteralPath
Anger en sökväg till en eller flera kommandomarkeringsfiler. Värdet för LiteralPath- används exakt som det skrivs. Inga tecken tolkas som wildcards. Om sökvägen innehåller escape-tecken omger du den med enkla citattecken. Enkla citattecken gör att PowerShell inte tolkar några tecken som escape-sekvenser.
Mer information finns i about_Quoting_Rules.
Parameteregenskaper
| Typ: | String[] |
| Standardvärde: | None |
| Stöder jokrar: | False |
| DontShow: | False |
| Alias: | PSPath, SP |
Parametermängder
Literal
| Position: | Named |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter fastighetsnamn: | True |
| Värde från återstående argument: | False |
-Path
Sökvägen till markdown-hjälpfilen som ska testas.
Parameteregenskaper
| Typ: | String[] |
| Standardvärde: | None |
| Stöder jokrar: | True |
| DontShow: | False |
Parametermängder
Item
| Position: | 0 |
| Obligatorisk: | True |
| Värde från pipeline: | True |
| Värde från pipeline efter fastighetsnamn: | True |
| Värde från återstående argument: | False |
CommonParameters
Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.