基于注释的帮助的语法

本部分介绍基于注释的帮助的语法。

语法关系图

基于注释的帮助的语法如下所示:

# .< 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.
#>