Yoruma Dayalı Yardım Anahtar Kelimeleri

Bu konu, yoruma dayalı yardımdaki anahtar sözcükleri listeler ve açıklar.

Yorum Tabanlı Yardımdaki Anahtar Kelimeler

Aşağıdakiler geçerli, yoruma dayalı Yardım anahtar sözcükleridir. Kullanım amaçlarıyla birlikte genellikle bir Yardım konusunda göründükleri sıraya göre listelenirler. Bu anahtar sözcükler, yoruma dayalı Yardım'da herhangi bir sırada görünebilir ve büyük/küçük harfe duyarlı değildir.

.EXTERNALHELP anahtar sözcüğünün tüm diğer yoruma dayalı yardım anahtar sözcüklerinden öncelikli olduğunu unutmayın. .EXTERNALHELP mevcut olduğunda Get-Help cmdlet'i, anahtar kelimenin değeriyle eşleşen bir yardım dosyası bulamadığında bile yoruma dayalı yardımı görüntülemez.

.ÖZET

İşlev veya komut dosyasının kısa bir açıklaması. Bu anahtar kelime her konu içerisinde yalnızca bir kez kullanılabilir.

.DESCRIPTION

İşlev veya komut dosyasının ayrıntılı açıklaması. Bu anahtar kelime her konuda yalnızca bir kez kullanılabilir.

.PARAMETER

Bir parametrenin açıklaması. İşlev veya komut dosyasındaki her parametre için bir .PARAMETER anahtar sözcüğü ekleyebilirsiniz.

.PARAMETER anahtar sözcükleri yorum bloğunda herhangi bir sırada görünebilir, ancak parametrelerin Param deyiminde veya işlev bildiriminde görünme sırası, parametrelerin sırasını belirler. Yardım konusunda görünür. Yardım konusundaki 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 ifadesine bir yorum yerleştirerek de bir parametre açıklaması belirtebilirsiniz. Hem Param ifadesi yorumu 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 yorumu dikkate alınmaz.

.ÖRNEK

İsteğe bağlı olarak örnek çıktı ve açıklamanın takip ettiği, işlevi veya betiği kullanan örnek bir komut. Bu anahtar kelimeyi her örnek için tekrarlayın.

.GİRİŞLER

İşleve veya komut dosyasına aktarılabilen Microsoft .NET Framework nesne türleri. Giriş nesnelerinin bir açıklamasını da ekleyebilirsiniz.

.ÇIKIŞLAR

Cmdlet'in döndürdüğü nesnelerin .NET Framework türü. Ayrıca döndürülen nesnelerin bir açıklamasını da ekleyebilirsiniz.

.NOTLAR

İşlev veya komut dosyası hakkında ek bilgi.

.LINK

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

.LINK anahtar kelime içeriği aynı Yardım konusunun çevrimiçi bir sürümüne yönelik bir Tekdüzen Kaynak Tanımlayıcısı (URI) da içerebilir. Get-Help'in Online parametresini kullandığınızda çevrimiçi sürüm açılır. URI "http" veya "https" ile başlamalıdır.

.BİLEŞEN

İşlev veya betiğin kullandığı ya da ilişkili olduğu teknolojinin veya özelliğin adı. Get-Help'in Bileşen parametresi, Get-Help tarafı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ı. Get-Help'in Role parametresi, Get-Help tarafından döndürülen arama sonuçlarını filtrelemek için bu değeri kullanır.

.İŞLEVSELLİK

İşlevin kullanım amacını açıklayan anahtar kelimeler. Get-Help'in İşlevsellik parametresi, Get-Help tarafından döndürülen arama sonuçlarını filtrelemek için bu değeri kullanır.

.FORWARDHELPTARGETNAME

Belirtilen komut için Yardım konusuna yönlendirir. Kullanıcıları bir işlev, komut dosyası, cmdlet veya sağlayıcıya ilişkin Yardım konuları da dahil olmak üzere herhangi bir Yardım konusuna yönlendirebilirsiniz.

.FORWARDHELPCATEGORY

.FORWARDHELPTARGETNAME içindeki öğenin Yardım kategorisini belirtir. Aynı ada sahip komutlar olduğunda çakışmaları önlemek için bu anahtar sözcüğü kullanın.

Geçerli değerler şunlardır:

• Takma ad
• Cmdlet'i
• HelpFile
• İşlev
• sağlayıcı
• Genel
• SSS
• Sözlük
• ScriptCommand
• ExternalScript
• Filtre
• Tüm

.REMOTEHELPRUNSPACE

Yardım konusunu içeren bir oturumu belirtir. PSSession içeren bir değişken girin. Bu anahtar kelime, dışa aktarılan komutlara ilişkin Yardım konularını bulmak için Export-PSSession cmdlet'i tarafından kullanılır.

.EXTERNALHELP

Komut dosyası veya işlev için XML tabanlı Yardım dosyasının yolunu ve/veya adını belirtir.

.EXTERNALHELP anahtar sözcüğü Get-Help cmdlet'ine XML tabanlı bir dosyadaki komut dosyası veya işlev için yardım almasını söyler. Bir komut dosyası veya işlev için XML tabanlı yardım dosyası kullanıldığında .EXTERNALHELP anahtar sözcüğü gereklidir. Bu olmadan, Get-Help, işlev veya komut dosyası için bir yardım dosyası bulamaz.

.EXTERNALHELP anahtar kelimesi, diğer tüm yoruma dayalı yardım anahtar kelimelerine göre önceliklidir. .EXTERNALHELP mevcut olduğunda Get-Help cmdlet'i, anahtar kelimenin değeriyle eşleşen bir yardım dosyası bulamadığında bile yoruma dayalı yardımı görüntülemez.

İşlev bir komut dosyası modülü tarafından dışa aktarıldığında, .EXTERNALHELP değeri, yolu olmayan bir dosya adı olmalıdır. Get-Help, dosyayı modül dizininin yerel ayara özgü bir alt dizininde arar. Dosya adı için herhangi bir gereksinim yoktur ancak en iyi uygulama şu dosya adı biçimini kullanmaktır: <ScriptModule>.psm1-help.xml.