-1

所以我编写了一些函数来简化我的常见任务,并尝试用相对适当的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:>帮助重启

名称 类别 模块概要
---- -------- ------ --------
服务重启功能...
Restart-Computer Cmdlet Microsoft.PowerShell.M... 重新启动(“重新启动”)本地和远程计算机上的操作系统。
Restart-Service Cmdlet Microsoft.PowerShell.M... 停止然后启动一项或多项服务。
4

2 回答 2

0

Comment based help requires 2 blank lines following the closing #>

于 2020-06-08T18:58:44.020 回答
0

.ALIAS 不是有效的基于注释的帮助关键字。Powershell 将显示该条目,但会省略除名称、语法、别名和备注之外的所有内容。

于 2020-07-15T12:46:48.387 回答