コマンドレットの説明を追加する方法

このセクションでは、コマンドレットヘルプの DESCRIPTION セクションに表示されるコンテンツ を 追加する方法について説明します。 ヘルプ ファイルでは、このコンテンツがコマンドレットごとに [コマンド ] ノードに追加されます。

注意

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

説明を追加するには

• まず、コマンドレットの基本的な機能について詳しく説明します。 多くの場合、コマンドレット名で使用される用語を説明し、使い慣れない概念を例で示すことができます。 たとえば、コマンドレットがファイルにデータを追加する場合は、既存のファイルの末尾にデータが追加されます。

• コマンドレットのすべての機能を見つけるには、パラメーターリストを確認します。 コマンドレットの主要な関数について説明し、その他の関数と機能を含める。 たとえば、コマンドレットのメイン関数が 1 つのプロパティを変更する場合に、コマンドレットですべてのプロパティを変更できます (詳細な説明で例を示します)。 コマンドレット パラメーターを使用して、ユーザーがさまざまな方法で情報を要求できる場合は、説明します。

• 明らかな用途に加えて、ユーザーがコマンドレットを使用する方法に関する情報を含める。 たとえば、コマンドレットが取得する オブジェクトを使用して、コマンド ウィンドウのテキストの色 Get-Host Windows PowerShellできます。

  例: "コマンドレット Get-Acl は、ファイルまたはリソースのセキュリティ記述子を表すオブジェクトを取得します。 セキュリティ記述子には、リソースのアクセス制御リスト (ACL) が含まれます。 ACL は、ユーザーとユーザー グループがリソースにアクセスするために必要なアクセス許可を指定します。"

• 詳細な説明ではコマンドレットについて説明する必要がありますが、コマンドレットで使用される概念を記述すべきではありません。 概念の定義を追加のメモに配置します。

参照

Windows PowerShell SDK