Справка на основе комментариев функции не отображается
Итак, я написал несколько функций для оптимизации моих общих задач и попытался документировать их с относительно 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 Microsoft.PowerShell.M... Останавливает, а затем запускает одну или несколько служб.
0 ответов
.ALIAS не является допустимым ключевым словом справки на основе комментариев. Powershell отобразит запись, но пропустит все, кроме имени, синтаксиса, псевдонимов и примечаний.
Для справки на основе комментариев требуется 2 пустые строки после закрывающего #>