Parancsmag súgófájljának létrehozása

Cikk
05/13/2022

Ez a szakasz azt ismerteti, hogyan hozhat létre érvényes XML-fájlt, amely Windows PowerShell parancsmag súgótémaköreinek tartalmát tartalmazza. Ez a szakasz a súgófájl elnevezését, a megfelelő XML-fejlécek hozzáadását, valamint a parancsmag súgótartalmainak különböző szakaszait tartalmazó csomópontok hozzáadását ismerteti.

Megjegyzés

A súgófájl teljes nézetéhez nyissa meg a dll-Help.xml Windows PowerShell telepítési könyvtárában található egyik fájlt. A fájl például Microsoft.PowerShell.Commands.Management.dll-Help.xml több PowerShell-parancsmag tartalmát tartalmazza.

Parancsmag súgófájljának létrehozása

Hozzon létre egy szövegfájlt, és mentse UTF8 kódolással. A fájlnévnek a következő formátummal kell rendelkeznie, hogy Windows PowerShell a parancsmag súgófájljaként észlelhesse.

<PSSnapInAssemblyName>.dll-Help.xml
Adja hozzá a következő XML-fejléceket a szövegfájlhoz. Vegye figyelembe, hogy a fájl a Microsoft Assistance Markup Language (MAML) sémával lesz érvényesítve. A PowerShell jelenleg nem biztosít semmilyen eszközt a fájl érvényesítéséhez.

<?xml version="1.0" encoding="utf-8" ?> <helpItems xmlns="http://msh" schema="maml">

Adjon hozzá egy parancscsomópontot a parancsmag súgófájlhoz a szerelvény minden parancsmagja számára. A parancscsomópont minden csomópontja a parancsmag súgótémakörének különböző szakaszaihoz kapcsolódik.

Az alábbi táblázat felsorolja az egyes csomópontok XML-elemét, majd az egyes csomópontok leírását.

Csomópont	Description
`<details>`	A parancsmag súgótémakörÉNEK NÉV és SYNOPSIS szakaszához ad hozzá tartalmat. További információ : A parancsmag nevének és szinopszisának hozzáadása.
`<maml:description>`	A parancsmag súgótémakörÉNEK LEÍRÁS szakaszához ad hozzá tartalmat. További információ : Részletes leírás hozzáadása parancsmag súgótémakörhöz.
`<command:syntax>`	Tartalom hozzáadása a parancsmag súgótémakör SZINTAXIS szakaszához. További információ: Szintaxis hozzáadása parancsmag súgótémakörhöz.
`<command:parameters>`	A parancsmag súgótémakörÉNEK PARAMÉTEREK szakaszához ad hozzá tartalmat. További információ: Paraméterek hozzáadása parancsmagok súgótémaköréhez.
`<command:inputTypes>`	Tartalmat ad hozzá a parancsmag súgótémakörÉNEK INPUTS szakaszához. További információ: Beviteli típusok hozzáadása parancsmag súgótémakörhöz.
`<command:returnValues>`	A parancsmag súgótémakörÉNEK OUTPUTS szakaszához ad hozzá tartalmat. További információ : Visszatérési értékek hozzáadása parancsmag súgótémakörhöz.
`<maml:alertset>`	A parancsmag súgótémakörÉNEK JEGYZETEK szakaszához ad hozzá tartalmat. További információt a Megjegyzések hozzáadása parancsmag súgótémakörhöz című témakörben talál.
`<command:examples>`	A parancsmag súgótémakörÉNEK EXAMPLES szakaszához ad hozzá tartalmat. További információ: Példák hozzáadása parancsmag súgótémakörhöz.
`<maml:relatedLinks>`	Tartalom hozzáadása a parancsmag súgótémakör KAPCSOLÓDÓ HIVATKOZÁSOK szakaszához. További információ : Kapcsolódó hivatkozások hozzáadása parancsmag súgótémakörhöz.

Példa

Íme egy példa egy parancscsomópontra , amely a parancsmag súgótémakörének különböző szakaszaihoz tartozó csomópontokat tartalmazza.

<command:command
  xmlns:maml="http://schemas.microsoft.com/maml/2004/10"
  xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"
  xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
  <command:details>
    <!--Add name and synopsis here-->
  </command:details>
  <maml:description>
    <!--Add detailed description here-->
  </maml:description>
  <command:syntax>
    <!--Add syntax information here-->
  </command:syntax>
  <command:parameters>
    <!--Add parameter information here-->
  </command:parameters>
  <command:inputTypes>
    <!--Add input type information here-->
  </command:inputTypes>
  <command:returnValues>
    <!--Add return value information here-->
  </command:returnValues>
  <maml:alertSet>
    <!--Add Note information here-->
  </maml:alertSet>
  <command:examples>
    <!--Add cmdlet examples here-->
  </command:examples>
  <maml:relatedLinks>
    <!--Add links to related content here-->
  </maml:relatedLinks>
</command:command>