Parancsmag súgófájljának létrehozásaHow to Create the Cmdlet Help File

Ez a szakasz azt ismerteti, hogyan lehet létrehozni egy érvényes XML-fájlt, amely tartalmazza a Windows PowerShell-parancsmag súgójának tartalmát.This section describes how to create a valid XML file that contains content for Windows PowerShell cmdlet Help topics. Ez a szakasz bemutatja, hogyan nevezheti el a súgófájl nevét, hogyan adhatja hozzá a megfelelő XML-fejléceket, és hogyan adhat hozzá olyan csomópontokat, amelyek a parancsmag súgójának különböző szakaszait fogják tartalmazni.This section discusses how to name the Help file, how to add the appropriate XML headers, and how to add nodes that will contain the different sections of the cmdlet Help content.

Megjegyzés

A súgófájl teljes nézetének megnyitásához nyissa meg a dll-Help.xml Windows PowerShell telepítési könyvtárában található fájlok egyikét.For a complete view of a Help file, open one of the dll-Help.xml files located in the Windows PowerShell installation directory. A Microsoft.PowerShell.Commands.Management.dll-Help.xml fájl például több PowerShell-parancsmaghoz tartalmaz tartalmakat.For example, the Microsoft.PowerShell.Commands.Management.dll-Help.xml file contains content for several of the PowerShell cmdlets.

Parancsmag-súgófájl létrehozásaHow to Create a Cmdlet Help File

  1. Hozzon létre egy szövegfájlt, és mentse az UTF8 kódolással.Create a text file and save it using UTF8 encoding. A fájlnévnek a következő formátumúnak kell lennie, hogy a Windows PowerShell parancsmag-súgófájlként tudja felderíteni.The filename must have the following format so that Windows PowerShell can detect it as a cmdlet Help file.

    <PSSnapInAssemblyName>.dll-Help.xml

  2. Adja hozzá a következő XML-fejléceket a szövegfájlhoz.Add the following XML headers to the text file. Vegye figyelembe, hogy a fájl a Microsoft Assistance Markup Language (MAML) sémával lesz érvényesítve.Be aware that the file will be validated against the Microsoft Assistance Markup Language (MAML) schema. A PowerShell jelenleg nem biztosít eszközöket a fájl érvényesítéséhez.Currently, PowerShell does not provide any tools to validate the file.

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

  3. Adjon hozzá egy parancssori csomópontot a parancsmag súgójához a szerelvényben található minden parancsmaghoz.Add a Command node to the cmdlet Help file for each cmdlet in the assembly. A parancs csomópontján belüli egyes csomópontok a parancsmag súgójának különböző részeire vonatkoznak.Each node within the Command node relates to the different sections of the cmdlet Help topic.

    A következő táblázat felsorolja az egyes csomópontok XML-elemét, majd az egyes csomópontok leírását.The following table lists the XML element for each node, followed by a descriptions of each node.

    CsomópontNode LeírásDescription
    <details> Tartalmat hoz létre a parancsmag súgójának NAME és SZINOPSZIS szakaszához.Adds content for the NAME and SYNOPSIS sections of the cmdlet Help topic. További információ: a parancsmag nevének és áttekintésének hozzáadása.For more information, see How to Add the Cmdlet Name and Synopsis.
    <maml:description> Tartalom hozzáadása a parancsmag súgójának Leírás szakaszához.Adds content for the DESCRIPTION section of the cmdlet Help topic. További információt a részletes leírás a parancsmagok súgójában való hozzáadásával foglalkozó témakörbentalál.For more information, see How to Add the Detailed Description to a Cmdlet Help Topic.
    <command:syntax> Tartalom hozzáadása a parancsmag súgójának szintaxis szakaszához.Adds content for the SYNTAX section of the cmdlet Help topic. További információ: Hogyan lehet szintaxist hozzáadni a parancsmagok súgója témakörhöz.For more information, see How to Add Syntax to a Cmdlet Help Topic.
    <command:parameters> Tartalom hozzáadása a parancsmag súgójának paraméterek szakaszához.Adds content for the PARAMETERS section of the cmdlet Help topic. További információkért lásd: Paraméterek hozzáadása parancsmagok súgója témakörhöz.For more information, see How to Add Parameters to a Cmdlet Help Topic.
    <command:inputTypes> Tartalom hozzáadása a parancsmag súgójának BEMENETek szakaszához.Adds content for the INPUTS section of the cmdlet Help topic. További információ: input types hozzáadása a parancsmag súgója témakörhöz.For more information, see How to Add Input Types to a Cmdlet Help Topic.
    <command:returnValues> Tartalmat ad a parancsmag súgójának OUTPUTs (kimenet) szakaszához.Adds content for the OUTPUTS section of the cmdlet Help topic. További információ: Return Values hozzáadása egy parancsmag Súgó témakörhöz.For more information, see How to Add Return Values to a Cmdlet Help Topic.
    <maml:alertset> Tartalom hozzáadása a parancsmag súgójának megjegyzések szakaszához.Adds content for the NOTES section of the cmdlet Help topic. További információ: Megjegyzések hozzáadása a parancsmagok súgója témakörhöz.For more information, see How to add Notes to a Cmdlet Help Topic.
    <command:examples> Tartalom hozzáadása a parancsmag súgójának példák szakaszához.Adds content for the EXAMPLES section of the cmdlet Help topic. További információkért lásd: példák hozzáadása a parancsmagok súgója témakörhöz.For more information, see How to Add Examples to a Cmdlet Help Topic.
    <maml:relatedLinks> Tartalom hozzáadása a parancsmag súgójának kapcsolódó hivatkozások szakaszához.Adds content for the RELATED LINKS section of the cmdlet Help topic. További információkért lásd: Kapcsolódó hivatkozások hozzáadása egy parancsmag Súgó témakörhöz.For more information, see How to Add Related Links to a Cmdlet Help Topic.

PéldaExample

Íme egy példa egy olyan parancs -csomópontra, amely a parancsmag súgójának különböző részeihez tartozó csomópontokat tartalmazza.Here is an example of a Command node that includes the nodes for the various sections of the cmdlet Help topic.

<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 an 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>

Lásd még:See Also

A parancsmag nevének és áttekintésének hozzáadásaHow to Add the Cmdlet Name and Synopsis

A részletes leírás hozzáadása egy parancsmag Súgó témakörhözHow to Add the Detailed Description to a Cmdlet Help Topic

Szintaxis hozzáadása egy parancsmagokkal kapcsolatos súgótémakörhözHow to Add Syntax to a Cmdlet Help Topic

Paraméterek hozzáadása a parancsmagok Súgó témaköréhezHow to Add Parameters to a Cmdlet Help Topic

Bemeneti típusok hozzáadása egy parancsmagokkal kapcsolatos súgótémakörhözHow to Add Input Types to a Cmdlet Help Topic

Visszatérési értékek hozzáadása egy parancsmagokkal kapcsolatos súgótémakörhözHow to Add Return Values to a Cmdlet Help Topic

Megjegyzések hozzáadása egy parancsmag Súgó témakörhözHow to add Notes to a Cmdlet Help Topic

Példák hozzáadása egy parancsmagokkal kapcsolatos súgótémakörhözHow to Add Examples to a Cmdlet Help Topic

Kapcsolódó hivatkozások hozzáadása egy parancsmagokkal kapcsolatos súgótémakörhözHow to Add Related Links to a Cmdlet Help Topic

Windows PowerShell SDKWindows PowerShell SDK