Test-MarkdownCommandHelp
Teste la structure d’un fichier d’aide Markdown.
Syntaxe
Item
Test-MarkdownCommandHelp
[-Path] <string[]>
[-DetailView]
[<CommonParameters>]
Literal
Test-MarkdownCommandHelp
-LiteralPath <string[]>
[-DetailView]
[<CommonParameters>]
Description
Cette commande lit un fichier d’aide Markdown et valide la structure du contenu d’aide en vérifiant la présence d’éléments requis dans l’ordre approprié. La commande retourne $true si le fichier réussit la validation. Le paramètre DetailView peut être utilisé pour afficher des informations de validation plus détaillées.
Exemples
Exemple 1 - Tester un fichier d’aide Markdown
Pour cet exemple, nous testons la structure d’un fichier d’aide du module Markdown. Ce test échoue, car la commande s’attend à tester un fichier d’aide de commande Markdown. La sortie affiche le type d’informations que vous pouvez attendre du paramètre 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.
Paramètres
-DetailView
Indique à la commande de générer des informations de validation détaillées.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-LiteralPath
Spécifie un chemin d’accès à un ou plusieurs fichiers markdown de commande. La valeur de LiteralPath est utilisée exactement comme elle est typée. Aucun caractère n’est interprété en tant que caractère générique. Si le chemin d’accès inclut des caractères d’échappement, mettez-le entre des guillemets simples. Les guillemets simples indiquent à PowerShell de ne pas interpréter de caractères comme séquences d’échappement.
Pour plus d'informations, consultez la section sur les règles de citation.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | PSPath, DP |
Jeux de paramètres
Literal
| Position: | Named |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-Path
Chemin d’accès au fichier d’aide Markdown à tester.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | True |
| DontShow: | False |
Jeux de paramètres
Item
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.