本主题列出并介绍基于注释的帮助中的关键字。
Comment-Based 帮助中的关键字
以下是基于注释的有效帮助关键字。 它们按“帮助”主题中通常与其预期用途一起显示的顺序列出。 这些关键字可以按基于注释的帮助中的任意顺序显示，并且它们不区分大小写。
请注意，.EXTERNALHELP 关键字优先于所有其他基于注释的帮助关键字。
当存在 .EXTERNALHELP 时，即使找不到与关键字值匹配的帮助文件，Get-Help cmdlet 也不会显示基于注释的帮助。
.SYNOPSIS
函数或脚本的简要说明。 此关键字在每个主题中只能使用一次。
.DESCRIPTION
函数或脚本的详细说明。 此关键字在每个主题中只能使用一次。
.PARAMETER <Parameter-Name>
参数的说明。 可以在函数或脚本中包含每个参数的 .PARAMETER 关键字。
.PARAMETER 关键字可以按注释块中的任意顺序显示，但参数在 param 语句或函数声明中显示的顺序决定了参数在帮助主题中的显示顺序。
若要更改 Help 主题中的参数顺序，请更改 param 语句或函数声明中参数的顺序。
还可以通过在参数变量名称前立即在 param 语句中放置注释来指定参数说明。 如果使用 param 语句注释和 .PARAMETER 关键字，则使用与 .PARAMETER 关键字关联的说明，并忽略 param 语句注释。
.EXAMPLE
使用函数或脚本的示例命令（可选）后跟示例输出和说明。 为每个示例重复此关键字。
.INPUTS
可传递给函数或脚本的 .NET 类型的对象。 还可以包括输入对象的说明。 为每个输入类型重复此关键字。
.OUTPUTS
cmdlet 返回的对象的 .NET 类型。 还可以包含返回对象的说明。 为每个输出类型重复此关键字。
.NOTES
有关函数或脚本的其他信息。
.LINK
相关主题的名称。 为每个相关主题重复此关键字。 此内容显示在帮助主题的“相关链接”部分中。
.LINK 关键字内容还可以将统一资源标识符（URI）包含在相同帮助主题的联机版本中。 使用 的 Get-Help 参数时，将打开联机版本。 URI 必须以 http 或 https. 开头。
.COMPONENT
函数或脚本使用的技术或功能的名称，或者它与之相关。
Component 的 Get-Help 参数使用此值筛选 Get-Help返回的搜索结果。
.ROLE
帮助主题的用户角色的名称。
Role 的 Get-Help 参数使用此值筛选 Get-Help返回的搜索结果。
.FUNCTIONALITY
描述函数的预期用途的关键字。
Functionality 的 Get-Help 参数使用此值筛选 Get-Help返回的搜索结果。
.FORWARDHELPTARGETNAME <Command-Name>
重定向到指定命令的帮助主题。 可以将用户重定向到任何帮助主题，包括函数、脚本、cmdlet 或提供程序的帮助内容。
# .FORWARDHELPTARGETNAME <Command-Name>
.FORWARDHELPCATEGORY
指定 .FORWARDHELPTARGETNAME 中的项的帮助类别。 有效值为 Alias、Cmdlet、HelpFile、Function、Provider、General、FAQ、Glossary、ScriptCommand、ExternalScript、Filter或 All。 使用此关键字可避免在具有相同名称的命令时发生冲突。
# .FORWARDHELPCATEGORY <Category>
.REMOTEHELPRUNSPACE <PSSession-variable>
指定包含帮助主题的会话。 输入包含 PSSession 对象的变量。 [Export-PSSession][09] cmdlet 使用此关键字查找导出命令的帮助内容。
# .REMOTEHELPRUNSPACE <PSSession-variable>
.EXTERNALHELP
为脚本或函数指定基于 XML 的帮助文件。
# .EXTERNALHELP <XML Help File>
在 XML 文件中记录函数或脚本时，需要 .EXTERNALHELP 关键字。 如果没有此关键字，Get-Help 找不到函数或脚本的基于 XML 的帮助文件。
.EXTERNALHELP 关键字优先于其他基于注释的帮助关键字。 如果存在 .EXTERNALHELP，则 Get-Help 不会显示基于注释的帮助，即使找不到与 .EXTERNALHELP 关键字的值匹配的帮助主题。
如果函数由模块导出，请将 .EXTERNALHELP 关键字的值设置为没有路径的文件名。
Get-Help 查找模块目录的语言特定子目录中的指定文件名。 函数的基于 XML 的帮助文件的名称没有要求，但最佳做法是使用以下格式：
<ScriptModule.psm1>-help.xml
如果函数未包含在模块中，请包含基于 XML 的帮助文件的路径。 如果该值包含路径并且该路径包含特定于 UI 区域性的子目录，则 Get-Help 会根据为 Windows 建立的语言后备标准递归搜索子目录以查找具有脚本或函数名称的 XML 文件，就像在模块目录中一样。
有关基于 cmdlet 帮助 XML 的帮助文件格式的详细信息，请参阅 如何编写 Cmdlet 帮助。
