カスタムPowerShellスクリプトまたは関数を作成していて、ヘルプ情報を追加する必要がありますか? このガイドでは、そのための手順を説明します。 このガイドの最初のセクションでは、PowerShellスクリプトまたは関数にヘルプを追加する2つの方法を学習します。 次に、2番目のセクションでは、いずれかの方法を使用してスクリプトにヘルプを追加する方法を学習します。 それだけでなく、スクリプトや関数にヘルプを追加することに関してよくある質問に答えるFAQセクションもあります。 PowerShellヘルプの概要 PowerShellコマンドレットの構文とパラメーターに関する情報が必要な場合は、Get-Helpコマンドを実行します。 たとえば、Get-ChildItemコマンドレットに関する情報が必要な場合は、以下のコマンドを実行します。 Get-Help Get-ChildItem これがPowerShellのコマンドの結果です… スクリーンショットからわかるように、Get-Helpコマンドは、コマンドレットのNAMEとSYNOPSISを返します。 それに加えて、構文、説明、およびGet-ChildItemに関するその他の関連情報も返しました。 この記事の目的は、このヘルプ情報を独自のPowerShellスクリプトまたは関数に追加する方法を説明することです。 最初の例では、スクリプトをPowerShell関数に変換すると、一部の情報が自動的に追加されます。 ただし、このガイドの後半で説明するように、関数にヘルプ情報を追加して、情報の一部を追加する必要があります。 PowerShellスクリプトまたは関数にヘルプを追加する方法は2つあります。 コメントベースのヘルプメソッドを使用する XMLヘルプファイルを作成する このガイドでは、コメントベースのヘルプを追加する方法を説明します。 XMLファイルメソッドを使用してヘルプを追加する方法については、次のWebサイトをご覧ください。 コマンドレットヘルプファイルを作成する方法。 最近PowerShellFunctionExplainedを更新したとき、記事の例を使用して関数を作成しました。 関数を呼び出します、 Get-ItemsBetweenDates。 […]
The post PowerShellスクリプトまたは関数にヘルプを追加する方法 appeared first on Gamingsym Japan.