Я пытаюсь использовать командлет Get-Help для отображения помощи на основе комментариев в том же формате, в котором он отображает разделы справки командлета, созданные из файлов XML. Возможность сделать это задокументирована в about_Comment_based_Help в TechNet, но когда я выполняю командлет get-help против моего script, я получаю только script имя возвращено. Любая помощь будет оценена!
PS C:\Admin> Get-Help .\checksystem.ps1 -full
checksystem.ps1
checksystem.ps1 script:
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
Он будет работать, но вы пытаетесь получить справку по script, но вы добавили помощь в эту функцию. Если вы разделите источник на script, а затем введите get-help isalive, вы увидите свою помощь для этой функции.
. .\checksystem.ps1 ; get-help isalive -full
Это работает, вы просто должны убедиться, что у вас есть правильные заголовки. Я всегда помещал блок комментариев прямо над функцией. Я не уверен, что он должен работать внутри функции или нет.
Ниже приведен пример одной из моих функций, в которой есть рабочая документация.
##############################################################################
#.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." }
}
}
}
Примечание. Если вы забыли добавить имя параметра после .PARAMETER, ни один из ваших собственных текстов справки не будет отображаться при запуске get-help
Аналогично, если вы не заметили какие-либо ключевые слова, пользовательская справка не будет отображаться.