Связаться по Skype: vkarabedyants
Позвонить Написать
+7 (499) 404-28-83

Блог о системном администрировании серверов и сайтов

Установка, настройка программного обеспечения Linux, Windows операционных систем

Включение в сценарии PowerShell справочную информацию

Если вам когда-либо доводилось работать с технологи­ей PowerShell, вы, скорее всего, использовали команду Get-Help (или один из ее псевдонимов — help и man). Справочная система загружается автоматически в ходе установки оболочки PowerShell, но, если вы работаете с третьей или более новой версией этого продукта, не забудьте выполнить команду Update-Help при первом запуске PowerShell и регулярно запускать ее в дальнейшем. Дело в том, что Microsoft постоянно добавляет в справочную систему новые темы и исправляет ошибки в существующих темах, обнаруженные сотрудниками компании, а также другими пользователями. Предоставляя возмож­ность выполнять команду Update-Help на вашей системе, Microsoft позволяет вам экономить значи­тельную часть дискового пространства, ведь на вашу машину загружаются средства поддержки лишь того языка, который вы определили для своей системы, а не для всех языков, которые, возможно, указала система.

Сценарий PowerShell GetHelp

Однако помощь, получаемая вами от PowerShell,— это еще не все. Взяв за основу справочную функцию на базе комментариев, реализованную разработчи­ками во второй версии PowerShell, вы можете предо­ставить такую же помощь будущим пользователям написанных вами функций и сценариев. В этой версии добавлена возможность включения в сценарии много­строчных комментариев. В качестве разделителей этих комментариев применяются пары символов ‘<#’ и ‘#>’. Используются они следующим образом:

Как применять справочную информацию

И как же использовать справочные данные в соот­ветствии с вашим замыслом? В сущности, все довольно просто. Достаточно определить в коммен­тарии несколько ключевых слов и поместить коммен­тарий в начало вашего сценария или в начало функ­ции, и тогда каждый, кто будет пользоваться этим сценарием или функцией, сможет получить помощь точно таким же образом, каким вы получали нужные сведения с помощью команды Get-Help. Ключевые слова, которые вы будете использовать, называются тегами. Я применяю такие базовые теги: .SYNOPSIS, DESCRIPTION и .EXAMPLE. Тег .SYNOPSIS позволяет дать краткое определение задачи, выполняемой сценарием или функцией. Тег .DESCRIPTION дает возможность представить более детальные сведения, а тег .EXAMPLE позволяет привести примеры применения вашего сценария или функции, с тем чтобы пользователь понял, как следует должным образом их вызывать. Ниже помещается раздел комментариев из сценария, который я использую для того, чтобы присвоить владельцам всех баз данных имя ‘sa’.

Вы также можете применять такие теги, как .PARAMETER для описания параметров, используе­мых в вашем коде, .INPUTS для описания типов объектов, которые могут быть переданы в ваш код по конвейеру, или .OUTPUTS для описания объек­тов, передаваемых на конвейер, .NOTES для передачи дополнительной информации, .LINK для передачи ссылок на дополнительные источники и т. д.

Сценарий PowerShell get-Help Set-Database

Включая подобного рода справочные данные в сце­нарии или функции, вы облегчите для тех, кто будет запускать их в дальнейшем, понимание того, какую задачу выполняет ваш код и как его следует исполь­зовать. Я обнаружил, что и мне самому эти данные помогают вспомнить, как пользоваться сценариями, которые я написал некоторое время назад.

Оставить комментарий

Лимит времени истёк. Пожалуйста, перезагрузите CAPTCHA.