about_Comment_Based_Help

[アーティクル]
11/16/2015

適用対象: Windows PowerShell 2.0, Windows PowerShell 3.0, Windows PowerShell 4.0, Windows PowerShell 5.0

概要をここに挿入してください。

トピック

about_Comment_Based_Help

概要

関数とスクリプトのコメントベースのヘルプトピックの作成方法について説明します。

詳細説明

特殊なヘルプコメントキーワードを使用して、関数とスクリプトのコメントベースのヘルプトピックを作成できます。

Get-Help コマンドレットは、XML ファイルから生成されるコマンドレットのヘルプトピックと同じ表示形式でコメントベースのヘルプを表示します。ユーザーは、Get-Help のすべてのパラメーター (Detailed、Full、Example、Online など) を使用して、コメントベースのヘルプの内容を表示できます。

さらに、関数とスクリプトの XML ベースのヘルプファイルを作成することもできます。関数またはスクリプトの XML ベースのヘルプファイルを Get-Help コマンドレットで検索できるようにするには、ExternalHelp キーワードを使用します。このキーワードを使用しない場合、Get-Help では、関数またはスクリプトの XML ベースのヘルプトピックを見つけることはできません。

このトピックでは、関数とスクリプトのヘルプトピックを作成する方法について説明します。関数とスクリプトのヘルプトピックを表示する方法については、「Get-Help」を参照してください。

注記:

Update-Help コマンドレットと Save-Help コマンドレットは、XML ファイルに対してのみ動作します。更新可能なヘルプでは、コメントベースのヘルプトピックがサポートされていません。

トラブルシューティング上の注意:

既定値と "ワイルドカード文字を許可する" の値は、関数またはスクリプトに定義されている場合でもパラメーター属性テーブルに表示されません。ユーザーをサポートするために、パラメーターの説明でこの情報を提供します。

コメントベースのヘルプの構文

コメントベースのヘルプの構文は、次のとおりです。

        # .< help keyword>
        # <help content>
 
    -or -

        <#
            .< help keyword>
            < help content>
        #>

コメントベースのヘルプは、一連のコメントとして作成されます。各コメント行の先頭にコメント記号 (#) を入力することも、"<#" 記号と "#>" 記号を使ってコメントブロックを作成することもできます。コメントブロック内の行はすべてコメントとして解釈されます。

コメントベースのヘルプトピックの行はすべて連続している必要があります。コメントベースのヘルプトピックをそのヘルプトピックの一部ではないコメントの後に配置する場合は、ヘルプではないコメントの最終行とコメントベースのヘルプの先頭との間に 1 行以上の空白行が必要です。

キーワードでは、コメントベースのヘルプの各セクションを定義します。それぞれのコメントベースのヘルプキーワードの前には、ドット (.) を付けます。キーワードの順序に決まりはありません。キーワード名では、大文字と小文字が区別されません。

たとえば、Description キーワードは、関数またはスクリプトの説明の前に配置します。

        <#
    .Description
            Get-Function displays the name and syntax of all functions in the session.
        #>

コメントブロックには、少なくとも 1 つのキーワードを含める必要があります。キーワード (EXAMPLE など) によっては、同じコメントブロック内に複数回配置することができます。各キーワードのヘルプコンテンツは、キーワードの後の行から開始し、複数の行にまたがることができます。

関数内のコメントベースのヘルプの構文

関数に関するコメントベースのヘルプは、次の 3 つの場所のいずれかに配置できます。

        -- At the beginning of the function body.

        -- At the end of the function body.

        -- Before the Function keyword. There cannot be more than one blank
           line between the last line of the function help and the Function
           keyword.

たとえば、次のように入力します。

        function Get-Function 
        {
            <#
            .< help keyword>
            < help content>
            #>

            <function commands>
        }


    -or -

        function Get-Function 
        {
            <function commands>

            <#
            .< help keyword>
            < help content>
            #>
        }

    -or -

        <#
        .< help keyword>
        < help content>
        #>
        function Get-Function { }

スクリプト内のコメントベースのヘルプの構文

スクリプトに関するコメントベースのヘルプは、スクリプト内の次の 2 つの場所のいずれかに配置できます。

     -- At the beginning of the script file. Script help can be preceded in the
       script only by comments and blank lines.


     -- If the first item in the script body (after the help) is a function
       declaration, there must be at least two blank lines between the end of the
       script help and the function declaration. Otherwise, the help is
       interpreted as being help for the function, not help for the script.


    -- At the end of the script file. However, if the script is signed, place
       Comment-based help at the beginning of the script file. The end of the 
       script is occupied by the signature block.

たとえば、次のように入力します。

        <#
        .< help keyword>
        < help content>
        #>


        function Get-Function { }

    -or-


        function Get-Function { }

        <#
        .< help keyword>
        < help content>
        #>

スクリプトモジュール内のコメントベースのヘルプの構文

スクリプトモジュール (.psm1) のコメントベースのヘルプでは、スクリプトの構文ではなく関数の構文を使用します。スクリプトの構文を使用して、スクリプトモジュールで定義されたすべての関数のヘルプを提供することはできません。

たとえば、ExternalHelp キーワードを使用してスクリプトモジュール内の関数の XML ベースのヘルプファイルを識別する場合は、それぞれの関数に ExternalHelp コメントを追加する必要があります。

    # .ExternalHelp <XML-file-name>
    function <function-name>
    {
        ...
    }

コメントベースのヘルプキーワード

有効なコメントベースのヘルプキーワードを次に示します。キーワードは、通常、ヘルプトピック内で表示される順に、その用途と共に示しています。これらのキーワードは、コメントベースのヘルプ内に任意の順序で表示できます。また、キーワードでは大文字と小文字は区別されません。

.SYNOPSIS

関数またはスクリプトの簡単な説明。このキーワードは、各トピックで 1 回だけ使用できます。

.DESCRIPTION

関数またはスクリプトの詳細な説明。このキーワードは、各トピックで 1 回だけ使用できます。

.PARAMETER <パラメーター名>

パラメーターの説明。関数またはスクリプトの構文では、パラメーターごとに .PARAMETER キーワードを追加します。

.PARAMETER キーワードと同じ行にパラメーター名を入力します。.PARAMETER キーワードの後の行にパラメーターの説明を入力します。Windows PowerShell では、.PARAMETER 行と次のキーワードまたはコメントブロックの末尾の間にあるすべてのテキストがパラメーターの説明の一部として解釈されます。説明には、段落区切りを含めることができます。

コメントブロック内では、Parameter キーワードの順序に決まりはありません。ただし、ヘルプトピックに表示されるパラメーター (とその説明) の順序は、関数またはスクリプトの構文によって決まります。順序を変更するには、構文を変更します。

さらに、関数またはスクリプトの構文でパラメーターの変数名の直前にコメントを配置することで、パラメーターの説明を指定することもできます。構文のコメントと Parameter キーワードの両方を使用した場合、Parameter キーワードに関連付けられた説明が使用され、構文のコメントは無視されます。

.EXAMPLE

関数またはスクリプトを使用するサンプルコマンド。必要に応じて、サンプル出力と説明を記述します。このキーワードは、それぞれの例で繰り返します。

.INPUTS

パイプを使用して関数またはスクリプトに渡すことができるオブジェクトの Microsoft .NET Framework 型。入力オブジェクトの説明を含めることもできます。

.OUTPUTS

コマンドレットによって返されるオブジェクトの .NET Framework 型。返されるオブジェクトの説明を含めることもできます。

.NOTES

関数またはスクリプトに関する追加情報。

.LINK

関連するトピックの名前。値は .LINK キーワードの下の行に表示され、値の前にコメント記号 (#) を付けるか、値をコメントブロックに含める必要があります。

関連トピックごとに、.LINK キーワードを繰り返します。

このコンテンツは、ヘルプトピックの「関連リンク」セクションに表示されます。

Link キーワードのコンテンツには、同じヘルプトピックのオンラインバージョンへの Uniform Resource Identifier (URI) も指定できます。オンラインバージョンは、Get-Help の Online パラメーターを使用した場合に開きます。URI は、"http" または "https" で始まる必要があります。

.COMPONENT

関数またはスクリプトで使用されているテクノロジや機能、関数またはスクリプトが関連するテクノロジや機能。このコンテンツは、Get-Help コマンドに Get-Help の Component パラメーターが含まれている場合に表示されます。

.ROLE

ヘルプトピックのユーザーロール。このコンテンツは、Get-Help コマンドに Get-Help の Role パラメーターが含まれている場合に表示されます。

.FUNCTIONALITY

関数の用途。このコンテンツは、Get-Help コマンドに Get-Help の Functionality パラメーターが含まれている場合に表示されます。

.FORWARDHELPTARGETNAME <コマンド名>

指定されたコマンドのヘルプトピックにリダイレクトします。関数、スクリプト、コマンドレット、プロバイダーのヘルプトピックなど、任意のヘルプトピックにユーザーをリダイレクトできます。

.FORWARDHELPCATEGORY <カテゴリ>

ForwardHelpTargetName の項目のヘルプカテゴリを指定します。有効な値は、Alias、Cmdlet、HelpFile、Function、Provider、General、FAQ、Glossary、ScriptCommand、ExternalScript、Filter、All です。同じ名前のコマンドが複数ある場合は、競合を避けるためにこのキーワードを使用します。

.REMOTEHELPRUNSPACE <PSSession 変数>

ヘルプトピックが含まれるセッションを指定します。PSSession が含まれる変数を入力します。このキーワードは、エクスポートされたコマンドのヘルプトピックを検索するために Export-PSSession コマンドレットによって使用されます。

.EXTERNALHELP <XML ヘルプファイル>

スクリプトまたは関数の XML ベースのヘルプファイルを指定します。

関数またはスクリプトが XML ファイルに記述されている場合は、ExternalHelp キーワードが必要です。このキーワードがないと、Get-Help は、関数またはスクリプトの XML ベースのヘルプファイルを見つけることができません。

ExternalHelp キーワードは、他のコメントベースのヘルプキーワードよりも優先されます。ExternalHelp が存在する場合、Get-Help は、ExternalHelp キーワードの値に一致するヘルプトピックが見つからない場合でも、コメントベースのヘルプを表示しません。

関数がモジュールによってエクスポートされる場合は、ExternalHelp キーワードの値を、パスを含まないファイル名に設定します。Get-Help は、指定されたファイル名をモジュールディレクトリの言語固有のサブディレクトリ内で探します。関数の XML ベースのヘルプファイルの名前に関する要件はありませんが、次の形式を使用することをお勧めします。

        <ScriptModule.psm1>-help.xml

関数がモジュールに含まれていない場合は、XML ベースのヘルプファイルへのパスを含めます。値にパスが含まれていて、そのパスに UI カルチャ固有のサブディレクトリが含まれている場合、Get-Help は、モジュールディレクトリの場合と同様に、Windows 向けに確立された言語フォールバック標準に従って、サブディレクトリで、スクリプトまたは関数の名前を含む XML ファイルを再帰的に検索します。

コマンドレットの XML ベースのヘルプファイルの形式の詳細については、MSDN (Microsoft Developer Network) ライブラリのコマンドレットのヘルプの作成方法に関するトピック (https://go.microsoft.com/fwlink/?LinkID=123415) を参照してください。

自動生成されるコンテンツ

名前、構文、パラメーターリスト、パラメーター属性テーブル、共通パラメーター、および注釈は、Get-Help コマンドレットによって自動的に生成されます。

名前:

関数のヘルプトピックの "名前" セクションは、関数構文の関数名から取得されます。スクリプトのヘルプトピックの名前は、スクリプトファイル名から取得されます。名前または大文字と小文字の使い分けを変更するには、関数構文またはスクリプトファイル名を変更します。

構文:

ヘルプトピックの "構文" セクションは、関数またはスクリプトの構文から生成されます。パラメーターの .NET Framework 型などの詳細をヘルプトピック構文に追加するには、詳細を構文に追加します。パラメーターの型を指定しない場合は、"Object" 型が既定値として挿入されます。

パラメーターリスト:

ヘルプトピックのパラメーターリストは、関数またはスクリプトの構文や、Parameters キーワードを使用して追加した説明から生成されます。関数のパラメーターは、関数またはスクリプトの構文に出現するのと同じ順序で、ヘルプトピックの "パラメーター" セクションに表示されます。パラメーター名のスペルと大文字と小文字の使い分けも構文から取得されます。これは、Parameter キーワードで指定されたパラメーター名による影響を受けません。

共通パラメーター:

共通パラメーターは、効果がない場合でも、ヘルプトピックの構文とパラメーターリストに追加されます。共通パラメーターの詳細については、「about_CommonParameters」を参照してください。

パラメーター属性テーブル:

Get-Help は、Get-Help の Full または Parameter パラメーターを使用したときに表示されるパラメーター属性のテーブルを生成します。Required、Position、および Default value 属性の値は、関数またはスクリプトの構文から取得されます。

トラブルシューティング上の注意:

既定値は、関数またはスクリプトで定義されている場合でも、パラメーター属性テーブルに表示されません。ユーザーをサポートするために、既定値をパラメーターの説明内で示します。

注釈:

ヘルプトピックの "注釈" セクションは、関数またはスクリプトの名前から自動的に生成されます。内容を変更したり、内容に影響を与えることはできません。

コメントベースのヘルプの無効化

[ニューヨーク州ニューヨーク市在住の Windows エンジニアである Rich Prescott 氏によって提案された手法を紹介します。]

コメントベースのヘルプを無効にすることができます。これにより、コメントベースのヘルプは、削除しなくても無効になります。

コメントベースのヘルプを無効にするには、コメントをヒア文字列で囲みます。ヒア文字列を非表示にするには、ヒア文字列を変数に代入するか、パイプを使用して Out-Null コマンドレットに渡します。

コマンドベースのヘルプは、無効になっている間は動作しません。

たとえば、次の関数には、コメントベースのヘルプがあります。

            <#
            .SYNOPSIS 
            Adds a file name extension to a supplied name.
            #>            
            function Add-Extension 
            {
                param ([string]$Name,[string]$Extension = "txt")
                ...
            }

コメントベースのヘルプを無効にするには、次の例に示すようにヒア文字列で囲みます。

            @"  
            <#
            .SYNOPSIS 
            Adds a file name extension to a supplied name.
            #>
            "@            
            function Add-Extension 
            {
                param ([string]$Name,[string]$Extension = "txt")
                ...
            }

無効になっているコメントベースのヘルプを非表示にするには、次の例に示すように、関数内でほかに使用されていないローカル変数にヒア文字列を代入します。また、パイプを使用して Out-Null コマンドレットにヒア文字列を渡すこともできます。

            $x = @"  
            <#
            .SYNOPSIS 
            Adds a file name extension to a supplied name.
            #>
            "@            
            function Add-Extension 
            {
                param ([string]$Name,[string]$Extension = "txt")
                ...
            }

ヒア文字列の詳細については、「about_Quoting_Rules」(https://go.microsoft.com/fwlink/?LinkID=113253) を参照してください。

例

例 1:関数のコメントベースのヘルプ

次のサンプル関数には、コメントベースのヘルプが含まれています。

            function Add-Extension 
            {
                param ([string]$Name,[string]$Extension = "txt")
                $name = $name + "." + $extension
                $name

            <#
            .SYNOPSIS 
            Adds a file name extension to a supplied name.

            .DESCRIPTION
            Adds a file name extension to a supplied name. 
            Takes any strings for the file name or extension.

            .PARAMETER Name
            Specifies the file name.

            .PARAMETER Extension
            Specifies the extension. "Txt" is the default.

            .INPUTS
            None. You cannot pipe objects to Add-Extension.

            .OUTPUTS
            System.String. Add-Extension returns a string with the extension or file name.

            .EXAMPLE
            C:\PS> extension -name "File"
            File.txt

            .EXAMPLE
            C:\PS> extension -name "File" -extension "doc"
            File.doc

            .EXAMPLE
            C:\PS> extension "File" "doc"
            File.doc

            .LINK
            http://www.fabrikam.com/extension.html

            .LINK
            Set-Item
            #>
            }

結果は、次のとおりです。

        C:\PS> get-help add-extension -full

        NAME
            Add-Extension
    
        SYNOPSIS
            Adds a file name extension to a supplied name.
    
        SYNTAX
            Add-Extension [[-Name] <String>] [[-Extension] <String>] [<CommonParameters>]
    
        DESCRIPTION
            Adds a file name extension to a supplied name. Takes any strings for the file name or extension.
    
        PARAMETERS
           -Name
               Specifies the file name.
        
               Required?                    false
               Position?                    0
               Default value                
               Accept pipeline input?       false
               Accept wildcard characters?  
        
           -Extension
               Specifies the extension. "Txt" is the default.
        
               Required?                    false
               Position?                    1
               Default value                
               Accept pipeline input?       false
               Accept wildcard characters?  
        
            <CommonParameters>
               This cmdlet supports the common parameters: -Verbose, -Debug,
               -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
               -OutBuffer and -OutVariable. For more information, type
               "get-help about_commonparameters".
            INPUTs
            None. You cannot pipe objects to Add-Extension.
        OUTPUTS
            System.String. Add-Extension returns a string with the extension or file name.
            -------------------------- EXAMPLE 1 --------------------------
    
            C:\PS> extension -name "File"
            File.txt
    
            -------------------------- EXAMPLE 2 --------------------------
    
            C:\PS> extension -name "File" -extension "doc"
            File.doc
    
            -------------------------- EXAMPLE 3 --------------------------
    
            C:\PS> extension "File" "doc"
            File.doc
    
        RELATED LINKS
            http://www.fabrikam.com/extension.html
            Set-Item

例 2:関数構文内のパラメーターの説明

この例は、関数構文にパラメーターの説明が挿入されている点を除き、前の例と同じです。この形式は、説明が簡潔な場合に最も役立ちます。

        function Add-Extension 
        {
            param 
            (
                [string]
                # Specifies the file name.
                $name,

                [string]
                # Specifies the file name extension. \"Txt\" is the default.
                $extension = "txt"
            )
            $name = $name + "." + $extension
            $name
      
            <#
            .SYNOPSIS 
            Adds a file name extension to a supplied name.

            .DESCRIPTION
            Adds a file name extension to a supplied name. Takes any strings for the file name or extension.

            .INPUTS
            None. You cannot pipe objects to Add-Extension.

            .OUTPUTS
            System.String. Add-Extension returns a string with the extension or file name.

            .EXAMPLE
            C:\PS> extension -name "File"
            File.txt

            .EXAMPLE
            C:\PS> extension -name "File" -extension "doc"
            File.doc

            .EXAMPLE
            C:\PS> extension "File" "doc"
            File.doc
 
            .LINK
            http://www.fabrikam.com/extension.html

            .LINK
            Set-Item
            #>
        }

例 3:スクリプトのコメントベースのヘルプ

次のサンプルスクリプトには、コメントベースのヘルプが含まれています。

閉じる "#>" と Param ステートメントの間にある空白行に注意してください。Param ステートメントを含まないスクリプトでは、ヘルプトピックの最後のコメントと最初の関数宣言との間に 2 行以上の空白行が必要です。このような空白行がない場合、Get-Help は、スクリプトではなく関数にヘルプトピックに関連付けます。

           <#
           .SYNOPSIS 
           Performs monthly data updates.

           .DESCRIPTION
           The Update-Month.ps1 script updates the registry with new data generated
           during the past month and generates a report.
    
           .PARAMETER InputPath
           Specifies the path to the CSV-based input file.

           .PARAMETER OutputPath
           Specifies the name and path for the CSV-based output file. By default, 
           MonthlyUpdates.ps1 generates a name from the date and time it runs, and
           saves the output in the local directory.

           .INPUTS
           None. You cannot pipe objects to Update-Month.ps1.

           .OUTPUTS
           None. Update-Month.ps1 does not generate any output.

           .EXAMPLE
           C:\PS> .\Update-Month.ps1

           .EXAMPLE
           C:\PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv

           .EXAMPLE
           C:\PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv -outputPath C:\Reports\2009\January.csv
           #>

           param ([string]$InputPath, [string]$OutPutPath)

           function Get-Data { }
           ...

次のコマンドは、スクリプトのヘルプを取得します。Path 環境変数に指定されたディレクトリにスクリプトがないため、スクリプトのヘルプを取得する Get-Help コマンドではスクリプトのパスを指定する必要があります。

            PS C:\ps-test> get-help .\update-month.ps1 -full

            NAME
                C:\ps-test\Update-Month.ps1

            SYNOPSIS
                Performs monthly data updates.

            SYNTAX
                C:\ps-test\Update-Month.ps1 [-InputPath] <String> [[-OutputPath]
                <String>] [<CommonParameters>]

            DESCRIPTION
                The Update-Month.ps1 script updates the registry with new data
                generated during the past month and generates a report.

            PARAMETERS
               -InputPath
                   Specifies the path to the CSV-based input file.
        
                   Required?                    true
                   Position?                    0
                   Default value                
                   Accept pipeline input?       false
                   Accept wildcard characters?

               -OutputPath
                   Specifies the name and path for the CSV-based output file. By
                   default, MonthlyUpdates.ps1 generates a name from the date
                   and time it runs, and saves the output in the local directory.
        
                   Required?                    false
                   Position?                    1
                   Default value                
                   Accept pipeline input?       false
                   Accept wildcard characters?

               <CommonParameters>
                   This cmdlet supports the common parameters: -Verbose, -Debug,
                   -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
                   -OutBuffer and -OutVariable. For more information, type,
                   "get-help about_commonparameters".

            INPUTS
                   None. You cannot pipe objects to Update-Month.ps1.

            OUTPUTS
                   None. Update-Month.ps1 does not generate any output.

            -------------------------- EXAMPLE 1 --------------------------
        
            C:\PS> .\Update-Month.ps1
    
            -------------------------- EXAMPLE 2 --------------------------
       
            C:\PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv
    
            -------------------------- EXAMPLE 3 --------------------------
    
            C:\PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv -outputPath 
            C:\Reports\2009\January.csv
        
            RELATED LINKS

例 4:XML ファイルへのリダイレクト

関数とスクリプトの XML ベースのヘルプトピックを作成できます。コメントベースのヘルプは簡単に実装できますが、更新可能なヘルプの場合やヘルプトピックを複数の言語で提供する場合は、XML ベースのヘルプが必要になります。

次の例は、Update-Month.ps1 スクリプトの最初の数行を示しています。このスクリプトでは、ExternalHelp キーワードを使用して、スクリプトの XML ベースのヘルプトピックへのパスを指定します。

ExternalHelp キーワードの値がキーワードと同じ行に配置されていることに注意してください。それ以外の配置はすべて無効になります。

            #  .ExternalHelp C:\MyScripts\Update-Month-Help.xml

            param ([string]$InputPath, [string]$OutPutPath)
            function Get-Data { }
            ...

次の例では、関数に ExternalHelp キーワードを指定する際に有効な 3 つの位置を示しています。

function Add-Extension 
            {
                # .ExternalHelp C:\ps-test\Add-Extension.xml

                param ([string] $name, [string]$extension = "txt")
                $name = $name + "." + $extension
                $name
            }
            
            function Add-Extension 
            {
                param ([string] $name, [string]$extension = "txt")
                $name = $name + "." + $extension
                $name
      
                # .ExternalHelp C:\ps-test\Add-Extension.xml
            }

           # .ExternalHelp C:\ps-test\Add-Extension.xml
           function Add-Extension 
            {
                param ([string] $name, [string]$extension = "txt")
                $name = $name + "." + $extension
                $name
            }

例 5:別のヘルプトピックへのリダイレクト

次のコードは、Windows PowerShell に組み込まれたヘルプ関数の先頭からの抜粋です。これにより、ヘルプテキストの画面が 1 つずつ表示されます。ヘルプ関数については Get-Help コマンドレットのヘルプトピックで説明されているため、ヘルプ関数では、ForwardHelpTargetName キーワードと ForwardHelpCategory キーワードを使用して、ユーザーを Get-Help コマンドレットのヘルプトピックにリダイレクトします。

            function help 
            {

            <#
            .FORWARDHELPTARGETNAME Get-Help
            .FORWARDHELPCATEGORY Cmdlet
            #>
            [CmdletBinding(DefaultParameterSetName='AllUsersView')]
            param(
                [Parameter(Position=0, ValueFromPipelineByPropertyName=$true)]
                [System.String]
                ${Name},
                   ...

この機能を使用するコマンドを次に示します。

            C:\PS> get-help help

            NAME
                Get-Help

            SYNOPSIS
                Displays information about Windows PowerShell cmdlets and concepts.
            ...

キーワード

about_Comment-Based_Help

about_Comment_Based_Help

トピック

概要

詳細説明

注記:

トラブルシューティング上の注意:

コメントベースのヘルプの構文

関数内のコメントベースのヘルプの構文

スクリプト内のコメントベースのヘルプの構文

スクリプトモジュール内のコメントベースのヘルプの構文

コメントベースのヘルプキーワード

.SYNOPSIS

.DESCRIPTION

.PARAMETER <パラメーター名>

.EXAMPLE

.INPUTS

.OUTPUTS

.NOTES

.LINK

.COMPONENT

.ROLE

.FUNCTIONALITY

.FORWARDHELPTARGETNAME <コマンド名>

.FORWARDHELPCATEGORY <カテゴリ>

.REMOTEHELPRUNSPACE <PSSession 変数>

.EXTERNALHELP <XML ヘルプファイル>

自動生成されるコンテンツ

コメントベースのヘルプの無効化

例

キーワード

関連項目

その他のリソース

about_Comment_Based_Help

トピック

概要

詳細説明

注記:

トラブルシューティング上の注意:

コメントベースのヘルプの構文

関数内のコメントベースのヘルプの構文

スクリプト内のコメントベースのヘルプの構文

スクリプト モジュール内のコメントベースのヘルプの構文

コメントベースのヘルプ キーワード

.SYNOPSIS

.DESCRIPTION

.PARAMETER <パラメーター名>

.EXAMPLE

.INPUTS

.OUTPUTS

.NOTES

.LINK

.COMPONENT

.ROLE

.FUNCTIONALITY

.FORWARDHELPTARGETNAME <コマンド名>

.FORWARDHELPCATEGORY <カテゴリ>

.REMOTEHELPRUNSPACE <PSSession 変数>

.EXTERNALHELP <XML ヘルプ ファイル>

自動生成されるコンテンツ

コメントベースのヘルプの無効化

例

キーワード

関連項目

その他のリソース

スクリプトモジュール内のコメントベースのヘルプの構文

コメントベースのヘルプキーワード

.EXTERNALHELP <XML ヘルプファイル>