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

[玩转系统] 将基于注释的帮助放入脚本中

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

将基于注释的帮助放入脚本中

本主题说明在何处放置脚本的基于注释的帮助，以便 Get-Help cmdlet 将基于注释的帮助主题与脚本关联，而不是与脚本中可能存在的任何函数关联。

在脚本文件的开头。
脚本中的脚本帮助前面只能有注释和空行。
在脚本文件的末尾。
如果脚本主体中的第一项（帮助之后）是函数声明，则脚本帮助末尾和函数声明之间必须至少有两个空行。否则，帮助将被解释为函数的帮助，而不是脚本的帮助。

以下示例显示了脚本的基于注释的帮助的每个放置选项。

以下示例显示了脚本开头的基于注释的情况。

<#
.Description
This script performs a series of network connection tests.
#>

param [string]$ComputerName
...

以下示例显示了脚本末尾基于注释的情况。

...
function Ping { Test-Connection -ComputerName $ComputerName }

<#
.Description
This script performs a series of network connection tests.
#>

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

精品推荐！: 任推帮：不扣量的项目拉新平台

炬焰：字节跳动旗下新流量变现平台

2T超大容量！点击领取

115联盟：在家兼职也能月入过万

最新评论

友情链接