共用方式為


在腳本中放置以批註為基礎的說明

本主題說明放置腳本批註型說明的位置,讓 Get-Help Cmdlet 將批注型說明主題與腳本產生關聯,而不是與腳本中可能的任何函式產生關聯。

放置腳本 Comment-Based 說明的位置

  • 在腳本檔案的開頭。

    腳本說明只能在腳本前面加上批註和空白行。

  • 在腳本檔案的結尾。

    如果腳本主體中的第一個專案(在 Help 之後)是函式宣告,腳本說明結尾與函式宣告之間必須至少有兩個空白行。 否則,說明會解譯為函式的說明,而不是腳本的說明。

腳本中說明放置的範例

下列範例顯示文稿之批注式說明的每個放置選項。

腳本開頭的說明

下列範例顯示腳本開頭的批注型。

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