Поделиться через

Синтаксис справки на основе комментариев

  • Статья

В этом разделе описывается синтаксис справки на основе комментариев.

Схема синтаксиса

Синтаксис справки на основе комментариев выглядит следующим образом:

# .< help keyword>
# <help content>

–или–

<#
.< help keyword>
< help content>
#>

Описание синтаксиса

Справка на основе комментариев написана в виде ряда комментариев. Вы можете ввести символ комментария (#) перед каждой строкой комментариев или использовать символы <# и #> для создания блока комментариев. Все строки в блоке комментариев интерпретируются как комментарии.

Каждый раздел справки на основе комментариев определяется ключевым словом, и каждое ключевое слово предшествует точке (.). Ключевые слова могут отображаться в любом порядке. Имена ключевых слов не чувствительны к регистру.

Блок комментариев должен содержать по крайней мере одно ключевое слово справки. Некоторые ключевые слова, такие как .EXAMPLE, могут отображаться несколько раз в одном блоке комментариев. Содержимое справки для каждого ключевого слова начинается в строке после ключевого слова и может охватывать несколько строк.

Все строки в разделе справки на основе комментариев должны быть смежными. Если раздел справки на основе комментариев следует за комментарием, который не входит в раздел справки, должен быть по крайней мере одна пустая строка между последней строкой комментариев, отличной от справки, и началом справки на основе комментариев.

Например, следующий раздел справки на основе комментариев содержит ключевое слово .DESCRIPTION и его значение, которое является описанием функции или скрипта.

<#
    .DESCRIPTION
    The Get-Function function displays the name and syntax of all functions in the session.
#>