Import-MamlHelp
Importa a ajuda MAML de um arquivo e cria objetos commandHelp para cada comando no arquivo.
Sintaxe
Path (Default)
Import-MamlHelp
[-Path] <string[]>
[<CommonParameters>]
LiteralPath
Import-MamlHelp
-LiteralPath <string[]>
[<CommonParameters>]
Description
Esse comando pode ser usado para criar objetos CommandHelp de arquivos de ajuda MAML. Esses objetos podem ser usados para gerar arquivos de ajuda do Markdown. Você também pode usar esse comando para testar a validade dos arquivos de ajuda MAML.
Exemplos
Exemplo 1
Import-MamlHelp -Path .\maml\Microsoft.PowerShell.PlatyPS.dll-Help.xml
Parâmetros
-LiteralPath
O caminho para o arquivo de ajuda MAML. Especifica um caminho para um ou mais locais. O valor de LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como caractere curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples indicam ao PowerShell que não deve interpretar nenhum caractere como uma sequência de escape.
Para mais informações, consulte sobre_Regras_de_Citação.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | PSPath, LP |
Conjuntos de parâmetros
LiteralPath
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-Path
O caminho para o arquivo de ajuda MAML. Especifica um caminho para um ou mais locais.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | True |
| DontShow: | False |
Conjuntos de parâmetros
Path
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
String
Saídas
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
Observações
O formato de arquivo MAML não dá suporte a todas as informações que podem ser armazenadas em um objeto CommandHelp. Se você converter as informações importadas em formato markdown, o arquivo markdown resultante não será uma representação completa do comando original.