Справка на основе комментариев функции не отображается - PullRequest
Новая
       29

Справка на основе комментариев функции не отображается

0 голосов
/ 01 февраля 2019

Итак, я написал несколько функций для упрощения моих общих задач и попытался документировать их с относительно правильной Get-Help информацией.Однако это не отображается.

У меня есть функции в моем $profile, это проблема?

Вот одна из моих функций, я попробовал сопоставить about_Comment_Based_Help : 

Function Service-Restarter ($service, $vm){

<#
.SYNOPSIS
Restart [redacted] services running on client/server.

.DESCRIPTION
Using the windows "Services" tool to connect to other clients/servers is very slow.
This function quickly restarts the [redacted] services running on a client/server.

.EXAMPLE
Service-Restarter service* Computer-Name-Here

.ALIAS
srestart
#>
    Restart-Service -InputObject $(Get-Service -ComputerName $vm -Name $service)
}
Set-Alias srestart Service-Restarter

Вот что Get-Help возвращает: 

[41]PS:>help srestart -full

NAME
    Service-Restarter
     SYNTAX
    Service-Restarter [[-service] <Object>] [[-vm] <Object>]

     PARAMETERS
    -service <Object>

        Required?                    false
        Position?                    0
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -vm <Object>

        Required?                    false
        Position?                    1
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

     INPUTS
    None

     OUTPUTS
    System.Object
     ALIASES
    srestart

REMARKS
    None

А вот что показывает общий поиск: 

[45]PS:>help restart

Name              Category Module                    Synopsis
----              -------- ------                    --------
Service-Restarter Function                           ...
Restart-Computer  Cmdlet   Microsoft.PowerShell.M... Restarts ("reboots") the operating system on local and remote computers.
Restart-Service   Cmdlet   Microsoft.PowerShell.M... Stops and then starts one or more services.
...