Страницы

понедельник, 27 декабря 2021 г.

Документирование функций и скриптов в Windows PowerShell 5

Настала очередь для заключительного веб-каста на тему продвинутых функций и скриптов в Windows PowerShell. И несмотря на то, что это все будет работать и с обычными функциями и скриптами, создание корректной документации, также является добавлением метаданных в код, наличие которых и отличает продвинутые функции от базовых.

В веб-касте представлено описание команд на языке Windows PowerShell, способов документирования функций и скриптов, в том числе представлен автоматический способ документирования. Центральное место в веб-касте отведено под описание справки на базе комментария (Comment-based Help). В веб-касте описывается синтаксис комментария справки и доступные теги, а также демонстрируется написание и отладка документации к функции. Дополнительно в веб-касте демонстрируется использовании справки на базе комментария в скрипте.

Подробности и видео: LebedevUM.

P.S. Это заключительный веб-каст в группе и хоть его материал напрямую и не связан с предыдущими, тем не менее, вы можете почерпнуть много полезного в предыдущих веб-кастах группы:

Все веб-касты в хронологическом порядке: Windows PowerShell 5.

P.S. А следующая группа веб-кастов будет посвящена модулям в Windows PowerShell и, в связи с выходом Windows 11, она будет записываться на базе новейшей операционной системы.

Комментариев нет:

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