コマンドレットのヘルプファイルを作成する方法

[アーティクル]
05/13/2022

このセクションでは、コマンドレットヘルプトピックのコンテンツを含む有効な XML ファイルWindows PowerShell作成する方法について説明します。このセクションでは、ヘルプファイルに名前を付ける方法、適切な XML ヘッダーを追加する方法、コマンドレットのヘルプコンテンツのさまざまなセクションを含むノードを追加する方法について説明します。

注意

ヘルプファイルを完全に表示するには、Windows PowerShell インストールディレクトリにあるファイルのいずれかをdll-Help.xml開きます。たとえば、ファイルには Microsoft.PowerShell.Commands.Management.dll-Help.xml いくつかの PowerShell コマンドレットのコンテンツが含まれています。

コマンドレットヘルプファイルを作成する方法

テキストファイルを作成し、UTF8 エンコードを使用して保存します。 Windows PowerShellがコマンドレットヘルプファイルとして検出できるように、ファイル名には次の形式が必要です。

<PSSnapInAssemblyName>.dll-Help.xml
次の XML ヘッダーをテキストファイルに追加します。ファイルは Microsoft Assistance Markup Language (MAML) スキーマに対して検証されることに注意してください。現在、PowerShell には、ファイルを検証するためのツールは用意されていません。

<?xml version="1.0" encoding="utf-8" ?> <helpItems xmlns="http://msh" schema="maml">

アセンブリ内の各コマンドレットのコマンドレットヘルプファイルに コマンド ノードを追加します。 コマンド ノード内の各ノードは、コマンドレットヘルプトピックのさまざまなセクションに関連しています。

次の表に、各ノードの XML 要素の後に、各ノードの説明を示します。

Node	説明
`<details>`	コマンドレットヘルプトピックの NAME セクションと SYNOPSIS セクションのコンテンツを追加します。詳細については、「コマンドレット名と概要を追加する方法」を参照してください。
`<maml:description>`	コマンドレットのヘルプトピックの DESCRIPTION セクションのコンテンツを追加します。詳細については、「コマンドレットヘルプトピックに詳細な説明を追加する方法」を参照してください。
`<command:syntax>`	コマンドレットのヘルプトピックの SYNTAX セクションのコンテンツを追加します。詳細については、「コマンドレットヘルプトピックに構文を追加する方法」を参照してください。
`<command:parameters>`	コマンドレットのヘルプトピックの PARAMETERS セクションのコンテンツを追加します。詳細については、「コマンドレットヘルプトピックにパラメーターを追加する方法」を参照してください。
`<command:inputTypes>`	コマンドレットのヘルプトピックの INPUTS セクションのコンテンツを追加します。詳細については、「コマンドレットヘルプトピックに入力型を追加する方法」を参照してください。
`<command:returnValues>`	コマンドレットヘルプトピックの OUTPUTS セクションのコンテンツを追加します。詳細については、「コマンドレットヘルプトピックに戻り値を追加する方法」を参照してください。
`<maml:alertset>`	コマンドレットのヘルプトピックの NOTES セクションのコンテンツを追加します。詳細については、「コマンドレットヘルプトピックにメモを追加する方法」を参照してください。
`<command:examples>`	コマンドレットのヘルプトピックの EXAMPLES セクションのコンテンツを追加します。詳細については、「コマンドレットヘルプトピックに例を追加する方法」を参照してください。
`<maml:relatedLinks>`	コマンドレットのヘルプトピックの [RELATED LINKS] セクションのコンテンツを追加します。詳細については、「コマンドレットヘルプトピックに関連リンクを追加する方法」を参照してください。

例

コマンドレットヘルプトピックのさまざまなセクションのノードを含む コマンド ノードの例を次に示します。

<command:command
  xmlns:maml="http://schemas.microsoft.com/maml/2004/10"
  xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"
  xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
  <command:details>
    <!--Add name and synopsis here-->
  </command:details>
  <maml:description>
    <!--Add detailed description here-->
  </maml:description>
  <command:syntax>
    <!--Add syntax information here-->
  </command:syntax>
  <command:parameters>
    <!--Add parameter information here-->
  </command:parameters>
  <command:inputTypes>
    <!--Add input type information here-->
  </command:inputTypes>
  <command:returnValues>
    <!--Add return value information here-->
  </command:returnValues>
  <maml:alertSet>
    <!--Add Note information here-->
  </maml:alertSet>
  <command:examples>
    <!--Add cmdlet examples here-->
  </command:examples>
  <maml:relatedLinks>
    <!--Add links to related content here-->
  </maml:relatedLinks>
</command:command>