当前位置:网站首页 > 更多 > 玩电脑 > 正文

[玩转系统] 基于评论的帮助关键字

作者:精品下载站 日期:2024-12-14 02:32:36 浏览:12 分类:玩电脑

基于评论的帮助关键字


本主题列出并描述了基于注释的帮助中的关键字。

基于注释的帮助中的关键字

以下是有效的基于注释的帮助关键字。它们按照它们通常在帮助主题中出现的顺序及其预期用途列出。这些关键字可以以任意顺序出现在基于注释的帮助中,并且不区分大小写。

请注意,.EXTERNALHELP 关键字优先于所有其他基于注释的帮助关键字。当 .EXTERNALHELP 存在时,Get-Help cmdlet 不会显示基于注释的帮助,即使它找不到与关键字值匹配的帮助文件也是如此。

.概要

函数或脚本的简要描述。该关键字在每个主题中只能使用一次。

.DESCRIPTION

函数或脚本的详细描述。该关键字在每个主题中只能使用一次。

.PARAMETER Param 语句注释被忽略。

.EXAMPLE

使用函数或脚本的示例命令,可选地后跟示例输出和描述。对每个示例重复此关键字。

.INPUTS

可通过管道传输到函数或脚本的 Microsoft .NET Framework 对象类型。您还可以包括输入对象的描述。

.输出

cmdlet 返回的对象的 .NET Framework 类型。您还可以包含返回对象的描述。

.NOTES

有关函数或脚本的附加信息。

.LINK

相关主题的名称。为每个相关主题重复此关键字。此内容显示在“帮助”主题的“相关链接”部分中。

.LINK 关键字内容还可以包含同一帮助主题的在线版本的统一资源标识符 (URI)。当您使用 Get-HelpOnline 参数时,会打开在线版本。 URI 必须以“http”或“https”开头。

.COMPONENT

函数或脚本使用的或与之相关的技术或功能的名称。 Get-HelpComponent 参数使用此值来过滤 Get-Help 返回的搜索结果。

.ROLE

帮助主题的用户角色的名称。 Get-HelpRole 参数使用此值来过滤 Get-Help 返回的搜索结果。

.功能

描述该函数的预期用途的关键字。 Get-HelpFunctionality 参数使用此值来过滤 Get-Help 返回的搜索结果。

.FORWARDHELPTARGETNAME

您需要 登录账户 后才能发表评论

取消回复欢迎 发表评论:

关灯