Export-MamlCommandHelp
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
エクスポートするオブジェクト 1 つ以上の CommandHelp。
パラメーターのプロパティ
| 型: | Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Encoding
マークダウン ファイルの書き込み時に使用するエンコード。 値が指定されていない場合、エンコードは既定で $OutputEncoding ユーザー設定変数の値になります。
パラメーターのプロパティ
| 型: | Encoding
|
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
Force パラメーターを使用して、出力ファイルが既に存在する場合は上書きします。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-OutputFolder
マークダウン ファイルが保存されているフォルダー。 フォルダーが存在しない場合は、作成されます。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
アクションを実行せずに何が起こるかのみを報告するモードでコマンドを実行します。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
出力