การวางความช่วยเหลือตามความคิดเห็นในสคริปต์

หัวข้อนี้อธิบายตำแหน่งที่จะวางความช่วยเหลือตามความคิดเห็นสำหรับสคริปต์ เพื่อให้ cmdlet Get-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.
#>