ค้นหาเว็บไซต์

วิธีเพิ่มคำอธิบาย Cmdlet

บันทึก

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

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

บันทึก

หากต้องการดูไฟล์วิธีใช้แบบเต็ม ให้เปิดไฟล์ dll-Help.xml ไฟล์ใดไฟล์หนึ่งที่อยู่ในไดเร็กทอรีการติดตั้ง PowerShell ตัวอย่างเช่น ไฟล์ Microsoft.PowerShell.Commands.Management.dll-Help.xml มีเนื้อหาสำหรับ PowerShell cmdlet ต่างๆ

เพื่อเพิ่มคำอธิบาย

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

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

  • รวมข้อมูลเกี่ยวกับวิธีที่ผู้ใช้สามารถใช้ cmdlet นอกเหนือจากการใช้งานที่ชัดเจน ตัวอย่างเช่น คุณสามารถใช้วัตถุที่ cmdlet Get-Host ดึงข้อมูลมาเพื่อเปลี่ยนสีของข้อความในหน้าต่างคำสั่ง Windows PowerShell

    ตัวอย่าง: "CMdlet Get-Acl ได้รับวัตถุที่แสดงถึงตัวบอกความปลอดภัยของไฟล์หรือทรัพยากร ตัวบอกเกี่ยวกับความปลอดภัยประกอบด้วยรายการควบคุมการเข้าถึง (ACL) ของทรัพยากร ACL ระบุสิทธิ์ที่ผู้ใช้ และกลุ่มผู้ใช้ต้องเข้าถึงทรัพยากร"

  • คำอธิบายโดยละเอียดควรอธิบาย cmdlet แต่ไม่ควรอธิบายแนวคิดที่ cmdlet ใช้ วางคำจำกัดความของแนวคิดไว้ในหมายเหตุเพิ่มเติม

ดูเพิ่มเติม

Windows PowerShell SDK

บทความที่เกี่ยวข้อง