วิธีเพิ่มตัวอย่างในหัวข้อวิธีใช้ cmdlet

สิ่งที่ควรรู้เกี่ยวกับตัวอย่างในวิธีใช้ cmdlet

• แสดงรายการชื่อพารามิเตอร์ทั้งหมดในคำสั่ง แม้ว่าชื่อพารามิเตอร์จะเป็นทางเลือกก็ตาม ซึ่งจะช่วยให้ผู้ใช้ตีความคำสั่งได้อย่างง่ายดาย

• หลีกเลี่ยงนามแฝงและชื่อพารามิเตอร์บางส่วน แม้ว่าจะทำงานใน PowerShell ก็ตาม

• ในคำอธิบายตัวอย่าง ให้อธิบายเหตุผลในการสร้างคำสั่ง อธิบายว่าทำไมคุณถึงเลือกพารามิเตอร์และค่าเฉพาะ และวิธีที่คุณใช้ตัวแปร

• หากคำสั่งใช้นิพจน์ ให้อธิบายโดยละเอียด

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

ช่วยดูที่แสดงตัวอย่าง

ตัวอย่างปรากฏเฉพาะในมุมมองโดยละเอียดและมุมมองทั้งหมดของวิธีใช้ cmdlet

การเพิ่มโหนดตัวอย่าง

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

<command:examples>
  <command:example>
  </command:example>
</command:examples>

การเพิ่มชื่อตัวอย่าง

XML ต่อไปนี้แสดงวิธีการเพิ่ม ชื่อ สำหรับตัวอย่าง ชื่อ ใช้เพื่อแยกตัวอย่างออกจากตัวอย่างอื่นๆ PowerShell ใช้ส่วนหัวมาตรฐานที่มีหมายเลขตัวอย่างตามลำดับ

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
  </command:example>
</command:examples>

การเพิ่มอักขระนำหน้า

XML ต่อไปนี้แสดงวิธีการเพิ่มอักขระ เช่น พร้อมท์ Windows PowerShell ที่แสดงทันทีก่อนคำสั่งตัวอย่าง (โดยไม่มีช่องว่างแทรกแซง) PowerShell ใช้พร้อมท์ Windows PowerShell: C:\PS>

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
    <maml:introduction>
      <maml:para>C:\PS></maml:para>
    </maml:introduction>
</command:example>
</command:examples>

การเพิ่มคำสั่ง

XML ต่อไปนี้แสดงวิธีการเพิ่มคำสั่งจริงของตัวอย่าง เมื่อเพิ่มคำสั่ง ให้พิมพ์ชื่อทั้งหมด (อย่าใช้นามแฝง) ของ cmdlets และพารามิเตอร์ นอกจากนี้ ให้ใช้อักขระตัวพิมพ์เล็กทุกครั้งที่เป็นไปได้

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
    <maml:introduction>
      <maml:para>C:\PS></maml:para>
    </maml:introduction>
    <dev:code> command </dev:code>
</command:example>
</command:examples>

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

XML ต่อไปนี้แสดงวิธีการเพิ่มคำอธิบายสำหรับตัวอย่าง PowerShell ใช้แท็ก <maml:para> ชุดเดียวสำหรับคำอธิบาย แม้ว่าจะสามารถใช้แท็ก <maml:para> ได้หลายแท็กก็ตาม

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
    <maml:introduction>
      <maml:para>C:\PS></maml:para>
    </maml:introduction>
    <dev:code> command </dev:code>
    <dev:remarks>
      <maml:para> command description </maml:para>
    </dev:remarks>
</command:example>
</command:examples>

การเพิ่มตัวอย่างเอาต์พุต

XML ต่อไปนี้แสดงวิธีการเพิ่มผลลัพธ์ของคำสั่ง ข้อมูลผลลัพธ์ของคำสั่งเป็นทางเลือก แต่ในบางกรณี การสาธิตผลกระทบของการใช้พารามิเตอร์เฉพาะจะเป็นประโยชน์ PowerShell ใช้แท็ก <maml:para> เปล่าสองชุดเพื่อแยกเอาต์พุตคำสั่งออกจากคำสั่ง

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
    <maml:introduction>
      <maml:para>C:\PS></maml:para>
    </maml:introduction>
    <dev:code> command </dev:code>
    <dev:remarks>
      <maml:para> command description </maml:para>
      <maml:para></maml:para>
      <maml:para></maml:para>
      <maml:para> command output </maml:para>
</dev:remarks>
</command:example>
</command:examples>