Import-MamlHelp
Importa la ayuda MAML de un archivo y crea objetos CommandHelp para cada comando del archivo.
Sintaxis
Path (Es el valor predeterminado).
Import-MamlHelp
[-Path] <string[]>
[<CommonParameters>]
LiteralPath
Import-MamlHelp
-LiteralPath <string[]>
[<CommonParameters>]
Description
Este comando se puede usar para crear CommandHelp objetos a partir de archivos de ayuda MAML. Estos objetos se pueden usar para generar archivos de ayuda de Markdown. También puede usar este comando para probar la validez de los archivos de ayuda mamL.
Ejemplos
Ejemplo 1
Import-MamlHelp -Path .\maml\Microsoft.PowerShell.PlatyPS.dll-Help.xml
Parámetros
-LiteralPath
Ruta de acceso al archivo de ayuda MAML. Especifica una ruta de acceso a una o varias ubicaciones. El valor de LiteralPath se usa exactamente como se escribe. Ninguno de los caracteres se interpreta como caracteres comodín. Si la ruta de acceso incluye caracteres de escape, escríbala entre comillas simples. Las comillas simples indican a PowerShell que no interprete ningún carácter como secuencias de escape.
Para obtener más información, consulte sobre_las_normas_de_citación.
Propiedades del parámetro
| Tipo: | String[] |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | PSPath, LP |
Conjuntos de parámetros
LiteralPath
| Posición: | Named |
| Mandatory: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | True |
| Valor de los argumentos restantes: | False |
-Path
Ruta de acceso al archivo de ayuda MAML. Especifica una ruta de acceso a una o varias ubicaciones.
Propiedades del parámetro
| Tipo: | String[] |
| Valor predeterminado: | None |
| Admite caracteres comodín: | True |
| DontShow: | False |
Conjuntos de parámetros
Path
| Posición: | 0 |
| Mandatory: | True |
| Valor de la canalización: | True |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
CommonParameters
Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.
Entradas
String
Salidas
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
Notas
El formato de archivo MAML no admite toda la información que se puede almacenar en un objeto commandHelp de . Si convierte la información importada en formato Markdown, el archivo markdown resultante no es una representación completa del comando original.