Import-MamlHelp
Importe l’aide MAML à partir d’un fichier et crée Objets CommandHelp pour chaque commande du fichier.
Syntaxe
Path (Par défaut)
Import-MamlHelp
[-Path] <string[]>
[<CommonParameters>]
LiteralPath
Import-MamlHelp
-LiteralPath <string[]>
[<CommonParameters>]
Description
Cette commande peut être utilisée pour créer des objets CommandHelp à partir de fichiers d’aide MAML. Ces objets peuvent être utilisés pour générer des fichiers d’aide Markdown. Vous pouvez également utiliser cette commande pour tester la validité des fichiers d’aide MAML.
Exemples
Exemple 1
Import-MamlHelp -Path .\maml\Microsoft.PowerShell.PlatyPS.dll-Help.xml
Paramètres
-LiteralPath
Chemin d’accès au fichier d’aide MAML. Spécifie un chemin d’accès à un ou plusieurs emplacements. 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
LiteralPath
| 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 MAML. Spécifie un chemin d’accès à un ou plusieurs emplacements.
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
Path
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | False |
| 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.
Entrées
String
Sorties
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
Notes
Le format de fichier MAML ne prend pas en charge toutes les informations qui peuvent être stockées dans un objet CommandHelp. Si vous convertissez les informations importées au format Markdown, le fichier markdown résultant n’est pas une représentation complète de la commande d’origine.