web-dev-qa-db-ja.com

Get-Helpコマンドレットを使用して、コメントベースのヘルプを同じ形式で表示します

Get-Helpコマンドレットを使用して、XMLファイルから生成されたコマンドレットヘルプトピックを表示するのと同じ形式でコメントベースのヘルプを表示しようとしています。これを行う機能は、TechNetの about_Comment_based_Help に記載されていますが、スクリプトに対してget-helpコマンドレットを実行すると、スクリプト名のみが返されます。どんな助けでもいただければ幸いです！

PS C:\Admin> Get-Help .\checksystem.ps1 -full
checksystem.ps1

checksystem.ps1スクリプト：

function IsAlive {
        <#
        .DESCRIPTION
        Checks to see whether a computer is pingable or not.

        .PARAMETER computername
        Specifies the computername.

        .EXAMPLE
        IsAlive -computername testwks01

        .NOTES
        This is just an example function.
        #>


            param (
                $computername
            )
            Test-Connection -count 1 -ComputerName $computername -TimeToLive 5 |
            Where-Object { $_.StatusCode -eq 0 } |
            Select-Object -ExpandProperty Address
        }

IsAlive -computername 192.168.1.1
powershellpowershell-2.0
19
Shaun

動作しますが、スクリプトのヘルプを実行しようとしています。関数にヘルプを追加しました。スクリプトをドットソースしてからget-helpisaliveと入力すると、関数のヘルプが表示されます。

. .\checksystem.ps1 ; get-help isalive -full
18
Andy Schneider

それは機能します、あなたはあなたが正しい見出しを持っていることを確認しなければなりません。私はいつもコメントブロックを関数の真上に置いてきました。関数内で動作するかどうかはわかりません。

以下は、ドキュメントヘルプが機能する私の関数の例です。

##############################################################################
#.SYNOPSIS
# Gets a COM object from the running object table (ROT) similar to GetObject
# in Visual Basic.
#
#.DESCRIPTION
# To maintain consistency with New-Object this cmdlet requires the -ComObject
# parameter to be provided and the TypeName parameter is not supported.
#
#.PARAMETER TypeName
# Not supported, but provided to maintain consistency with New-Object.
#
#.PARAMETER ComObject
# The ProgID of a registered COM object, such as MapPoint.Application.
#
#.PARAMETER Force
# If an existing object is not found, instead of writing an error, a new
# instance of the object will be created and returned.
#
#.EXAMPLE
# $olMailItem = 0
# Get-Object -ComObject Outlook.Application | %{$_.CreateItem($olMailItem).Display()}
##############################################################################
function Get-Object {

    [CmdletBinding(DefaultParameterSetName='Net')]
    param (

        [Parameter(ParameterSetName='Net', Position=1, Mandatory=$true)]
        [String]$TypeName,

        [Parameter(ParameterSetName='Com', Mandatory=$true)]
        [String]$ComObject,

        [Parameter()]
        [Switch]$Force

    )

    if ( $TypeName ) { throw '-TypeName is not supported. Use -ComObject instead.' }

    if ( $ComObject ) { 
        try {
            [System.Runtime.InteropServices.Marshal]::GetActiveObject($ComObject)
        }
        catch [System.Management.Automation.MethodInvocationException] {
            if ( $Force ) { New-Object -ComObject $ComObject }
            else { Write-Error "An active object of type $ComObject is not available." }
        }
    }

}
12
Josh

注-.PARAMETERの後にパラメーターの名前を追加するのを忘れた場合、get-helpを実行したときにカスタムヘルプテキストは表示されません。

同様に、キーワードのスペルを間違えると、カスタムヘルプは表示されません。

6
Daniel Flippance