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