Comment-Based súgó kulcsszavak

Ez a témakör a megjegyzésalapú súgóban felsorolja és ismerteti a kulcsszavakat.

Kulcsszavak a Comment-Based súgójában

Az alábbiak érvényes megjegyzésalapú súgószavak. A súgótémakörben általában megjelenő sorrendben jelennek meg a kívánt használatukkal együtt. Ezek a kulcsszavak bármilyen sorrendben megjelenhetnek a megjegyzésalapú súgóban, és nem érzékenyek a kis- és nagybetűkre.

Vegye figyelembe, hogy a .EXTERNALHELP kulcsszó elsőbbséget élvez az összes többi megjegyzésalapú súgó kulcsszóval szemben. Ha .EXTERNALHELP jelen van, a Get-Help parancsmag nem jelenít meg megjegyzésalapú súgót, még akkor sem, ha nem talál olyan súgófájlt, amely megfelel a kulcsszó értékének.

.SYNOPSIS

A függvény vagy szkript rövid leírása. Ez a kulcsszó csak egyszer használható az egyes témakörökben.

.DESCRIPTION

A függvény vagy szkript részletes leírása. Ez a kulcsszó csak egyszer használható az egyes témakörökben.

.PARAMETER <Parameter-Name>

Egy paraméter leírása. A függvény vagy szkript minden paraméteréhez .PARAMETER kulcsszót is megadhat.

A .PARAMETER kulcsszavak bármilyen sorrendben megjelenhetnek a megjegyzésblokkban, de a paraméterek param utasításban vagy függvénydeklarációban való megjelenésének sorrendje határozza meg, hogy a paraméterek milyen sorrendben jelenjenek meg a súgótémakörben. Ha módosítani szeretné a paraméterek sorrendjét a súgótémakörben, módosítsa a paraméterek sorrendjét a param utasításban vagy függvénydeklarációban.

A paraméter leírását úgy is megadhatja, hogy közvetlenül a paraméterváltozó neve előtt megjegyzést helyez el a param utasításban. Ha param utasítás-megjegyzést és .PARAMETER kulcsszót is használ, a rendszer a .PARAMETER kulcsszóhoz társított leírást használja, és a param utasítás megjegyzését figyelmen kívül hagyja.

.EXAMPLE

A függvényt vagy szkriptet használó mintaparancs, amelyet opcionálisan mintakimenet és leírás követ. Ismételje meg ezt a kulcsszót minden példában.

.INPUTS

A függvényhez vagy szkripthez csövezhető .NET típusú objektumok. A bemeneti objektumok leírását is megadhatja. Ismételje meg ezt a kulcsszót minden beviteli típushoz.

.OUTPUTS

A parancsmag által visszaadott objektumok .NET-típusa. A visszaadott objektumok leírását is megadhatja. Ismételje meg ezt a kulcsszót minden kimeneti típushoz.

.NOTES

További információ a függvényről vagy a szkriptről.

.LINK

Egy kapcsolódó témakör neve. Ismételje meg ezt a kulcsszót minden kapcsolódó témakör esetében. Ez a tartalom a súgótémakör Kapcsolódó hivatkozások szakaszában jelenik meg.

A .LINK kulcsszótartalmak tartalmazhatnak egy egységes erőforrás-azonosítót (URI) is ugyanazon súgótémakör online verziójához. Az online verzió a Get-Help paraméterének használatakor nyílik meg. Az URI-nak a következővel http kell kezdődnie: vagy https.

.COMPONENT

Annak a technológiának vagy funkciónak a neve, amelyet a függvény vagy a szkript használ, vagy amelyhez kapcsolódik. A ComponentGet-Help paramétere ezzel az értékkel szűri a Get-Helpáltal visszaadott keresési eredményeket.

.ROLE

A súgótémakör felhasználói szerepkörének neve. A RoleGet-Help paramétere ezzel az értékkel szűri a Get-Helpáltal visszaadott keresési eredményeket.

.FUNCTIONALITY

A függvény rendeltetését leíró kulcsszavak. A FunctionalityGet-Help paramétere ezzel az értékkel szűri a Get-Helpáltal visszaadott keresési eredményeket.

.FORWARDHELPTARGETNAME <Command-Name>

Átirányítja a megadott parancs súgótémakörére. A felhasználókat bármilyen súgótémakörbe átirányíthatja, beleértve egy függvény, szkript, parancsmag vagy szolgáltató súgótartalmat is.

# .FORWARDHELPTARGETNAME <Command-Name>

.FORWARDHELPCATEGORY

Az elem súgókategóriáját adja meg a .FORWARDHELPTARGETNAME. Az érvényes értékek a következők: Alias, Cmdlet, HelpFile, Function, Provider, General, FAQ, Glossary, ScriptCommand, ExternalScript, Filtervagy All. Ezzel a kulcsszóval elkerülheti az ütközéseket, ha azonos nevű parancsok vannak.

# .FORWARDHELPCATEGORY <Category>

.REMOTEHELPRUNSPACE <PSSession-variable>

A súgótémakört tartalmazó munkamenetet adja meg. Adjon meg egy változót, amely PSSession objektumot tartalmaz. Ezt a kulcsszót az [Export-PSSession][09] parancsmag használja az exportált parancsok súgótartalmainak megkereséséhez.

# .REMOTEHELPRUNSPACE <PSSession-variable>

.EXTERNALHELP

Xml-alapú súgófájlt ad meg a szkripthez vagy függvényhez.

# .EXTERNALHELP <XML Help File>

A .EXTERNALHELP kulcsszóra akkor van szükség, ha egy függvény vagy szkript XML-fájlokban van dokumentálva. E kulcsszó nélkül Get-Help nem találja a függvényhez vagy szkripthez tartozó XML-alapú súgófájlt.

A .EXTERNALHELP kulcsszó elsőbbséget élvez más megjegyzésalapú súgószavaknál. Ha .EXTERNALHELP jelenik meg, Get-Help nem jelenít meg megjegyzésalapú súgót, még akkor sem, ha nem talál olyan súgótémakört, amely megfelel a .EXTERNALHELP kulcsszó értékének.

Ha a függvényt egy modul exportálja, állítsa a .EXTERNALHELP kulcsszó értékét elérési út nélküli fájlnévre. Get-Help A megadott fájlnevet keresi a modulkönyvtár nyelvspecifikus alkönyvtárában. A függvény XML-alapú súgófájljának nevére nem vonatkoznak követelmények. A PowerShell 5.0-tól kezdve a modul által exportált függvények dokumentálhatók a modulhoz elnevezett súgófájlban. Nem kell megjegyzés kulcsszót használnia .EXTERNALHELP . Ha például a modul exportálja a Test-FunctionMyModule függvényt, nevezze el a súgófájlt MyModule-help.xml. A Get-Help parancsmag segítséget keres a Test-Function modulkönyvtárban található fájlban MyModule-help.xml található függvényhez.

Ha a függvény nem szerepel egy modulban, adja meg az XML-alapú súgófájl elérési útját. Ha az érték tartalmaz egy elérési utat, és az elérési út UI-kultúraspecifikus alkönyvtárakat tartalmaz, Get-Help rekurzívan keres az alkönyvtárakban egy OLYAN XML-fájlban, amelynek neve a szkript vagy függvény neve, a Windowshoz létrehozott nyelvi tartalék szabványoknak megfelelően, ugyanúgy, mint egy modulkönyvtárban.

A parancsmag xml-alapú súgófájlformátumával kapcsolatos további információkért lásd A parancsmag írása súgócímű témakört.