Test-MarkdownCommandHelp
Test de structuur van een Markdown-Help-bestand.
Syntaxis
Item
Test-MarkdownCommandHelp
[-Path] <string[]>
[-DetailView]
[<CommonParameters>]
Literal
Test-MarkdownCommandHelp
-LiteralPath <string[]>
[-DetailView]
[<CommonParameters>]
Description
Met deze opdracht wordt een Markdown-Help-bestand gelezen en wordt de structuur van de Help-inhoud gevalideerd door te controleren op de aanwezigheid van vereiste elementen in de juiste volgorde. De opdracht retourneert $true als het bestand de validatie doorstaat. De parameter DetailView kan worden gebruikt om gedetailleerdere validatiegegevens weer te geven.
Voorbeelden
Voorbeeld 1: een Markdown-Help-bestand testen
In dit voorbeeld testen we de structuur van een Help-bestand van de Markdown-module. Deze test mislukt omdat de opdracht verwacht een Help-bestand voor Markdown-opdrachten te testen. In de uitvoer ziet u het soort informatie dat u kunt verwachten van de parameter 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.
Parameters
-DetailView
Hiermee wordt de opdracht geïnstrueerd om gedetailleerde validatiegegevens uit te voeren.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | False |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-LiteralPath
Hiermee geeft u een pad naar een of meer opdracht Markdown-bestanden. De waarde van LiteralPath- wordt precies gebruikt zoals deze is getypt. Er worden geen tekens geïnterpreteerd als jokertekens. Als het pad escape-tekens bevat, zet het dan tussen enkele aanhalingstekens. Enkele aanhalingstekens zorgen ervoor dat PowerShell geen tekens als escapesequenties interpreteert.
Zie about_Quoting_Rulesvoor meer informatie.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
| Aliassen: | PSPath, LP |
Parametersets
Literal
| Position: | Named |
| Verplicht: | True |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | True |
| Waarde van resterende argumenten: | False |
-Path
Het pad naar het Help-bestand van Markdown om te testen.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | True |
| DontShow: | False |
Parametersets
Item
| Position: | 0 |
| Verplicht: | True |
| Waarde uit pijplijn: | True |
| Waarde uit pijplijn op eigenschapsnaam: | True |
| Waarde van resterende argumenten: | False |
CommonParameters
Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.