Используйте командлет Get-Help для отображения справки на основе комментариев в том же формате

Question

Я пытаюсь использовать командлет Get-Help для отображения справки на основе комментариев в том же формате, в котором отображаются разделы справки по командлетам, созданные из файлов XML.Возможность сделать это задокументирована в about_Comment_based_Help на TechNet, но когда я выполняю командлет get-help для своего скрипта, я получаю только возвращенное имя скрипта.Буду признателен за любую помощь!

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

Сценарий checkystem.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

Answer 1

Это будет работать, но вы пытаетесь запустить получить справку по сценарию.Вы добавили помощь в функцию.Если вы укажете источник своего скрипта, а затем наберете get-help isalive, вы увидите свою справку по этой функции.

Answer 2

Это работает, вы просто должны убедиться, что у вас есть правильные заголовки. Я всегда помещал блок комментариев прямо над функцией тоже. Я не уверен, должен ли он работать внутри функции или нет.

Ниже приведен пример одной из моих функций, в которой есть справка о рабочем документе.

##############################################################################
#.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." }
        }
    }

}

Answer 3

Примечание. Если вы забудете добавить имя параметра после .PARAMETER, при запуске get-help

ни один из ваших пользовательских текстов справки не будет отображаться.

Точно так же, если вы неправильно введете какое-либо из ключевых слов, пользовательская справка не будет отображаться.