องค์ประกอบที่สร้างขึ้นอัตโนมัติของความช่วยเหลือตามความคิดเห็น

Get-Help cmdlet จะสร้างองค์ประกอบต่างๆ ของหัวข้อตามความคิดเห็นโดยอัตโนมัติ องค์ประกอบที่สร้างขึ้นอัตโนมัติเหล่านี้ทำให้ความช่วยเหลือตามความคิดเห็นมีลักษณะคล้ายกับความช่วยเหลือที่สร้างจากไฟล์ XML

องค์ประกอบที่สร้างขึ้นโดยอัตโนมัติ

Get-Help cmdlet จะสร้างองค์ประกอบต่อไปนี้ของหัวข้อวิธีใช้โดยอัตโนมัติ คุณไม่สามารถแก้ไของค์ประกอบเหล่านี้ได้โดยตรง แต่เปลี่ยนผลลัพธ์ได้โดยการเปลี่ยนแหล่งที่มาขององค์ประกอบ

ชื่อ

ส่วนชื่อของหัวข้อวิธีใช้ฟังก์ชันจะนำมาจากชื่อฟังก์ชันในคำจำกัดความของฟังก์ชัน ชื่อของหัวข้อวิธีใช้สคริปต์นำมาจากชื่อไฟล์สคริปต์ หากต้องการเปลี่ยนชื่อหรือตัวพิมพ์ใหญ่ ให้เปลี่ยนคำจำกัดความของฟังก์ชันหรือชื่อไฟล์สคริปต์

ไวยากรณ์

ส่วนไวยากรณ์ของหัวข้อวิธีใช้ถูกสร้างขึ้นจากรายการพารามิเตอร์ในคำสั่ง Param ของฟังก์ชันหรือสคริปต์ เมื่อต้องการเพิ่มรายละเอียดให้กับไวยากรณ์หัวข้อวิธีใช้ เช่น ประเภท .NET ของพารามิเตอร์ ให้เพิ่มรายละเอียดลงในรายการพารามิเตอร์ หากคุณไม่ระบุประเภทพารามิเตอร์ ระบบจะแทรกประเภท Object เป็นค่าเริ่มต้น

รายการพารามิเตอร์

ส่วนพารามิเตอร์ของหัวข้อวิธีใช้ถูกสร้างขึ้นจากรายการพารามิเตอร์ในฟังก์ชันหรือสคริปต์ และจากคำอธิบายที่คุณเพิ่มโดยใช้คีย์เวิร์ด .Parameters หรือข้อคิดเห็นในรายการพารามิเตอร์

พารามิเตอร์จะปรากฏในส่วนพารามิเตอร์ในลำดับเดียวกันกับที่ปรากฏในรายการพารามิเตอร์ การสะกดและการใช้อักษรตัวพิมพ์ใหญ่ของชื่อพารามิเตอร์ยังนำมาจากรายการพารามิเตอร์ด้วย ไม่ได้รับผลกระทบจากชื่อพารามิเตอร์ที่ระบุโดยคีย์เวิร์ด .Parameter

พารามิเตอร์ทั่วไป

พารามิเตอร์ทั่วไปจะถูกเพิ่มลงในรายการไวยากรณ์และพารามิเตอร์ของหัวข้อวิธีใช้ แม้ว่าจะไม่มีผลก็ตาม สำหรับข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์ทั่วไป โปรดดูที่ about_CommonParameters

ตารางแอตทริบิวต์พารามิเตอร์

Get-Help สร้างตารางของแอตทริบิวต์พารามิเตอร์ที่ปรากฏขึ้นเมื่อคุณใช้พารามิเตอร์ เต็ม หรือ พารามิเตอร์ ของ Get-Help. ค่าของแอตทริบิวต์ค่า จำเป็น, ตำแหน่ง และ ค่าเริ่มต้น นำมาจากฟังก์ชันหรือไวยากรณ์ของสคริปต์

หมายเหตุ

ส่วนหมายเหตุของหัวข้อวิธีใช้จะถูกสร้างขึ้นโดยอัตโนมัติจากชื่อฟังก์ชันหรือสคริปต์ คุณไม่สามารถเปลี่ยนแปลงหรือส่งผลกระทบต่อเนื้อหาได้