フィードバック

コマンドレットのヘルプ トピックにコマンドレットの名前と概要を追加する方法

  • [アーティクル]

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

注意

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

コマンドレット名と概要を追加するには

  • コマンドレットのヘルプには、コマンドレットの2つの説明が表示されます。 最初の説明は、簡単な説明です。 2番目の説明では、詳細な説明を コマンドレットヘルプトピックに追加する方法について詳しく説明します。 これらの説明は、両方とも1つの段落として記述する必要があります。

  • ここでは、コマンドレット名を繰り返しません。 コマンドレットがサーバーを取得することをユーザーに通知するの Get-Server は簡単ですが、情報はありません。 代わりに、シノニムを使用し、詳細を説明に追加します。

    例: "ローカルコンピューターまたはリモートコンピューターを表すオブジェクトを取得します。"

  • "Get"、"create"、"change" のような単純な動詞を使用します。 "Set" はあいまいであるため、"modify" などの凝った単語は使用しないでください。

    例: "ファイル内の Authenticode 署名に関する情報を取得します。"

  • アクティブな音声で書き込みます。 たとえば、"TimeSpan オブジェクトの使用...""TimeSpan オブジェクトを使用して..." を

  • オブジェクトを取得するコマンドレットを記述するときは、動詞 "display" を避けてください。 Windows PowerShell コマンドレットのデータは表示されますが、このコマンドレットによって返されるデータが表示されない .NET Framework オブジェクトの概念にユーザーを導入することが重要です。 表示を強調すると、コマンドレットで表示されない他の便利なプロパティやメソッドが多数返された可能性があることをユーザーが認識できない可能性があります。

参照

Windows PowerShell SDK