Yardım Anahtar Sözcüklerini Comment-Based

Bu konu başlığı altında açıklama tabanlı yardımda anahtar sözcükler listelenir ve açıklanmaktadır.

Comment-Based Yardımı'nda anahtar sözcükler

Aşağıda geçerli açıklama tabanlı Yardım anahtar sözcükleri yer alır. Bunlar, genellikle amaçlanan kullanımlarıyla birlikte bir Yardım konusunda göründükleri sırayla listelenir. Bu anahtar sözcükler açıklama tabanlı Yardım'da herhangi bir sırada görünebilir ve büyük/küçük harfe duyarlı değildir.

.EXTERNALHELP anahtar sözcüğü, diğer tüm açıklama tabanlı yardım anahtar sözcüklerinden önceliklidir. .EXTERNALHELP mevcut olduğunda, Get-Help cmdlet'i, anahtar sözcüğün değeriyle eşleşen bir yardım dosyası bulamadığında bile açıklama tabanlı yardım görüntülemez.

.SYNOPSIS

İşlevin veya betiğin kısa bir açıklaması. Bu anahtar sözcük her konuda yalnızca bir kez kullanılabilir.

.DESCRIPTION

İşlevin veya betiğin ayrıntılı açıklaması. Bu anahtar sözcük her konuda yalnızca bir kez kullanılabilir.

.PARAMETER <Parameter-Name>

Parametrenin açıklaması. İşlevdeki veya betikteki her parametre için bir .PARAMETER anahtar sözcüğü ekleyebilirsiniz.

.PARAMETER anahtar sözcükleri açıklama bloğunda herhangi bir sırada görünebilir, ancak parametrelerin param deyiminde veya işlev bildiriminde görünme sırası, parametrelerin Yardım konusunda hangi sırada görüneceğini belirler. Yardım konusunda parametrelerin sırasını değiştirmek için, param deyimindeki veya işlev bildirimindeki parametrelerin sırasını değiştirin.

Ayrıca parametre değişkeni adından hemen önce param deyimine bir açıklama ekleyerek parametre açıklaması belirtebilirsiniz. Hem param deyimi açıklamasını hem de .PARAMETER anahtar sözcüğünü kullanırsanız, .PARAMETER anahtar sözcüğüyle ilişkili açıklama kullanılır ve param deyimi açıklaması yoksayılır.

.EXAMPLE

İşlevi veya betiği kullanan örnek bir komut, isteğe bağlı olarak örnek çıktı ve açıklama. Her örnek için bu anahtar sözcüğü yineleyin.

.INPUTS

İşleve veya betike aktarılabilir nesnelerin .NET türleri. Giriş nesnelerinin açıklamasını da ekleyebilirsiniz. Her giriş türü için bu anahtar sözcüğü yineleyin.

.OUTPUTS

Cmdlet'in döndürdüğü nesnelerin .NET türü. Döndürülen nesnelerin açıklamasını da ekleyebilirsiniz. Her çıkış türü için bu anahtar sözcüğü yineleyin.

.NOTES

İşlev veya betik hakkında ek bilgiler.

.LINK

İlgili bir konunun adı. İlgili her konu için bu anahtar sözcüğü yineleyin. Bu içerik, Yardım konusunun İlgili Bağlantılar bölümünde görünür.

.LINK anahtar sözcük içeriği, aynı yardım konusunun çevrimiçi sürümüne tekdüzen Kaynak Tanımlayıcısı (URI) da içerebilir. Online parametresini kullandığınızda Get-Helpçevrimiçi sürüm açılır. URI veya httpile https başlamalıdır.

.COMPONENT

İşlevin veya betiğin kullandığı veya ilişkili olduğu teknolojinin veya özelliğin adı. Component Get-Help parametresi, Get-Helptarafından döndürülen arama sonuçlarını filtrelemek için bu değeri kullanır.

.ROLE

Yardım konusu için kullanıcı rolünün adı. Role Get-Help parametresi, Get-Helptarafından döndürülen arama sonuçlarını filtrelemek için bu değeri kullanır.

.FUNCTIONALITY

İşlevin amaçlanan kullanımını açıklayan anahtar sözcükler. Functionality Get-Help parametresi, Get-Helptarafından döndürülen arama sonuçlarını filtrelemek için bu değeri kullanır.

.FORWARDHELPTARGETNAME <Command-Name>

Belirtilen komutun yardım konusuna yönlendirir. Kullanıcıları bir işlev, betik, cmdlet veya sağlayıcı için yardım içeriği dahil olmak üzere herhangi bir yardım konusuna yönlendirebilirsiniz.

# .FORWARDHELPTARGETNAME <Command-Name>

.FORWARDHELPCATEGORY

.FORWARDHELPTARGETNAMEiçindeki öğenin yardım kategorisini belirtir. Geçerli değerler Alias, Cmdlet, HelpFile, Function, Provider, General, FAQ, Glossary, ScriptCommand, ExternalScript, Filterveya All. Aynı ada sahip komutlar olduğunda çakışmaları önlemek için bu anahtar sözcüğü kullanın.

# .FORWARDHELPCATEGORY <Category>

.REMOTEHELPRUNSPACE <PSSession-variable>

Yardım konusunu içeren bir oturum belirtir. PSSession nesnesi içeren bir değişken girin. Bu anahtar sözcük, dışarı aktarılan komutların yardım içeriğini bulmak için [Export-PSSession][09] cmdlet'i tarafından kullanılır.

# .REMOTEHELPRUNSPACE <PSSession-variable>

.EXTERNALHELP

Betik veya işlev için XML tabanlı yardım dosyasını belirtir.

# .EXTERNALHELP <XML Help File>

xml dosyalarında bir işlev veya betik belgelendiğinde .EXTERNALHELP anahtar sözcüğü gereklidir. Bu anahtar sözcük olmadan, Get-Help işlev veya betik için XML tabanlı yardım dosyasını bulamaz.

.EXTERNALHELP anahtar sözcüğü, diğer açıklama tabanlı yardım anahtar sözcüklerinden önceliklidir. .EXTERNALHELP mevcutsa, Get-Help, .EXTERNALHELP anahtar sözcüğünün değerine uyan bir yardım konusu bulamasa bile açıklama tabanlı yardımı göstermez.

İşlev bir modül tarafından dışarı aktarılırsa, .EXTERNALHELP anahtar sözcüğü değerini yolu olmayan bir dosya adı olarak ayarlayın. Get-Help modül dizininin dile özgü bir alt dizininde belirtilen dosya adını arar. bir işlev için XML tabanlı yardım dosyasının adı için herhangi bir gereksinim yoktur. PowerShell 5.0'da başlayarak, modül tarafından dışarı aktarılan işlevler, modül için adlandırılan bir yardım dosyasında belgelenebilir. Açıklama anahtar sözcüğünü kullanmanız .EXTERNALHELP gerekmez. Örneğin, işlev modül tarafından MyModule dışarı aktarılırsaTest-Function, yardım dosyasını MyModule-help.xmlolarak adlandırabilirsiniz. Cmdlet, Get-Help modül dizinindeki MyModule-help.xml dosyasındaki işlev için Test-Function yardım arar.

İşlev bir modüle dahil değilse, XML tabanlı yardım dosyasının yolunu ekleyin. Değer bir yol içeriyorsa ve yol UI kültürüne özgü alt dizinler içeriyorsa Get-Help alt dizinlerde, aynı modül dizininde olduğu gibi, Windows için oluşturulan dil geri dönüş standartlarına uygun olarak betiğin veya işlevin adıyla bir XML dosyası için özyinelemeli olarak arama yapar.

Cmdlet yardımı XML tabanlı yardım dosyası biçimi hakkında daha fazla bilgi için bkz. Cmdlet Yardımı Yazma Yönergeleri.