Export-MamlCommandHelp

模块:

Microsoft.PowerShell.PlatyPS Module

将 CommandHelp 对象导出到 MAML 文件。

语法

__AllParameterSets

Export-MamlCommandHelp
    [-CommandHelp] <CommandHelp[]>
    [-OutputFolder] <string>
    [-Encoding <Encoding>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

此命令将 CommandHelp 对象转换为 MAML 文件。 MAML 文件包含 Get-Help 命令所使用的格式的帮助内容。

示例

示例 1 - 为模块创建 MAML 帮助文件

$mdfiles = Measure-PlatyPSMarkdown -Path .\v2\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    Export-MamlCommandHelp -OutputFolder .\maml

    Directory: D:\Git\PS-Src\platyPS\v2docs\maml

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           8/26/2024  3:18 PM         160928 Microsoft.PowerShell.PlatyPS-Help.xml

参数

-CommandHelp

要导出的一个或多个 CommandHelp 对象。

参数属性

类型:	Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	0
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Confirm

在运行 cmdlet 之前，提示你进行确认。

参数属性

类型:	SwitchParameter
默认值:	False
支持通配符:	False
不显示:	False
别名:	cf

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Encoding

写入 markdown 文件时要使用的编码。 如果未指定任何值，则编码默认为 $OutputEncoding 首选项变量的值。

参数属性

类型:	Encoding
默认值:	False
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Force

使用 Force 参数覆盖输出文件（如果已存在）。

参数属性

类型:	SwitchParameter
默认值:	False
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-OutputFolder

保存 markdown 文件的文件夹。 如果此文件夹不存在，则创建一个。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	1
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-WhatIf

在仅报告将发生的情况而不执行作的模式下运行命令。

参数属性

类型:	SwitchParameter
默认值:	False
支持通配符:	False
不显示:	False
别名:	无线

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

输入

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

输出

FileInfo

相关链接

• Import-MarkdownCommandHelp