Как добавить описание командлета

В этом разделе описывается добавление содержимого, которое отображается в разделе Описание справки по командлету. В файле справки это содержимое добавляется в узел команды для каждого командлета.

Примечание

Для получения полного представления файла справки откройте один из dll-Help.xml файлов, расположенных в каталоге установки PowerShell. Например, Microsoft.PowerShell.Commands.Management.dll-Help.xml файл содержит содержимое для некоторых командлетов PowerShell.

Добавление описания

• Начните с объяснения основных функций командлета более подробно. Во многих случаях можно объяснить термины, используемые в имени командлета, и проиллюстрировать неизвестные концепции с помощью примера. Например, если командлет добавляет данные в файл, объясните, что он добавляет данные в конец существующего файла.

• Чтобы найти все функции командлета, ознакомьтесь со списком параметров. Опишите основную функцию командлета, а затем включите другие функции и функции. Например, если основной функцией командлета является изменение одного свойства, но командлет может изменить все свойства, скажем, в подробном описании. Если параметры командлета позволяют пользователям запросить информацию различными способами, объясните их.

• Включите сведения о способах, с помощью которых пользователи могут использовать командлет, в дополнение к очевидным применениям. например, можно использовать объект, который Get-Host извлекает командлет, для изменения цвета текста в окне команд Windows PowerShell.

  Пример: " Get-Acl командлет получает объекты, представляющие дескриптор безопасности файла или ресурса. Дескриптор безопасности содержит списки управления доступом (ACL) ресурса. Список ACL задает разрешения, которые пользователи и группы пользователей должны иметь к ресурсу. "

• Подробное описание должно описывать командлет, но не должно описывать концепции, используемые командлетом. Помещайте определения концепций в дополнительные примечания.

См. также:

Пакет SDK для Windows PowerShell