Aracılığıyla paylaş

PowerShell Modülleri için Yardım Yazma

PowerShell modülleri, modülle ilgili Yardım konularını ve cmdlet'ler, sağlayıcılar, işlevler ve betikler gibi modül üyelerini içerebilir. Get-Help Cmdlet, modül Yardım konularını diğer PowerShell öğeleri için Yardım'ı görüntülerken kullanıcılar yardım konularını almak için standart Get-Help komutları kullandığı biçimde görüntüler.

Bu belgede modül Yardımı konularının biçimi ve doğru yerleşimi açıklanmaktadır ve modül Yardım içeriği için yönergeler önermektedir.

Modül Yardımı Türleri

Modül aşağıdaki Yardım türlerini içerebilir.

  • XML tabanlı yardım

    • Cmdlet Yardımı. Modüldeki cmdlet'leri açıklayan Yardım konuları, komut yardım şemasını kullanan XML dosyalarıdır
    • Sağlayıcı Yardımı. Modüldeki sağlayıcıları açıklayan Yardım konuları, sağlayıcı yardım şemasını kullanan XML dosyalarıdır.
    • İşlev Yardımı. Modüldeki işlevleri açıklayan Yardım konuları, işlev içindeki komut yardım şemasını veya açıklama tabanlı Yardım konularını ya da betik veya betik modülünü kullanan XML dosyaları olabilir
    • Betik Yardımı. Bir modüldeki betikleri açıklayan Yardım konuları, betik veya betik modülünde komut yardım şemasını veya açıklama tabanlı Yardım konularını kullanan XML dosyaları olabilir.
    • $PSHOME\Schemas\PSMaml klasörü, XML biçimini tanımlayan şema dosyalarını içerir.

  • Kavramsal ("Hakkında") yardım metin dosyaları

    Modülü ve üyelerini açıklamak ve üyelerin görevleri gerçekleştirmek için birlikte nasıl kullanılabileceğini açıklamak için kavramsal ("hakkında") Bir Yardım konusu kullanabilirsiniz. Varsayılan olarak, PowerShell bu kavramsal Yardım hakkında konu başlıklarından 100'den fazla içerir. Dosya adı gibi about_<name>.help.txtbir biçim kullanmalıdırabout_MyModule.help.txt.

    Uyarı

    TOPIC Bölüm üst bilgisi, dosyanın ilk satırının ilk sütununda başlamalıdır. İkinci satırdaki bölüm içeriği, sonek olmadan dosya adıyla .help.txt eşleşmelidir. İçeriği tam olarak 4 boşluk girintili olarak girintili olarak yazmanız gerekir. Üçüncü satır boş olmalıdır. Bölüm SYNOPSIS üst bilgisi dördüncü satırın ilk sütununda başlamalıdır. Beşinci satırdaki içeriğin girintisini tam olarak 4 boşlukla yazmanız gerekir. Cmdlet'in Get-Help içeriği doğru şekilde tanıması için bu gereksinimler gereklidir.

    TOPIC
    about_<subject or module name>

SYNOPSIS
    A short, one-line description of the topic contents.

    Kavramsal Yardım konuları yazmak için başlangıç noktası olarak aşağıdaki örnek şablonu kullanabilirsiniz. İlk iki bölüm dışında kavramsal Yardım konularının yapısı rastgeledir. Kalan bölüm başlıkları, içeriğiniz için uygun olan her şey olabilir.

    TOPIC
    about_<subject or module name>

SYNOPSIS
    A short, one-line description of the topic contents.

LONG DESCRIPTION

A detailed, full description of the subject or purpose of the module.

EXAMPLES

Examples of how to use the module or how the subject feature works in
practice.

TROUBLESHOOTING

Instructions for resolving common problems.

SEE ALSO

Text-only references for further reading. Hyperlinks can't work in the
PowerShell console.

    İstediğiniz stili ve işaretlemeyi kullanabilirsiniz, ancak PowerShell bunu düz metin olarak görür ve PowerShell konsolunda metnin özel bir işlemesi yoktur. Aşağıdaki öneriler en iyi görüntü sonuçlarını ve okunabilirliği sağlar.

    • Özel (çok baytlı) karakterlerin doğru görüntülendiğinden emin olmak için UTF-8'i BOM kodlamasıyla kullanın.
    • Bölüm üst bilgilerinin altını çizin veya dikkat çekmelerini sağlamak için tüm büyük harfleri kullanın. Bu, içeriğin taranmesini kolaylaştırır.
    • Her satırın uzunluğunu 80 karakterle sınırlayın.
    • Kod bloklarını ve örnek çıkışı girintileyerek bunları çevresindeki yordamdan ayırın.

Modül Yardımı'nın Yerleşimi

Cmdlet, Get-Help modül dizininin dile özgü alt dizinlerinde modül Yardım konusu dosyalarını arar.

Örneğin, aşağıdaki dizin yapısı diyagramı SampleModule modülü için Yardım konularının konumunu gösterir.

<ModulePath>
    \SampleModule
        \<en-US>
            \about_SampleModule.help.txt
            \SampleModule.dll-help.xml
            \SampleNestedModule.dll-help.xml
        \<fr-FR>
            \about_SampleModule.help.txt
            \SampleModule.dll-help.xml
            \SampleNestedModule.dll-help.xml

Uyarı

Örnekte yer tutucu, <ModulePath> ortam değişkenindeki PSModulePath , veya kullanıcının belirttiği özel bir yol gibi $HOME\Documents\Modules$PSHOME\Modulesyollardan birini temsil eder.

Modül Yardımı Alma

Kullanıcı bir modülü bir oturuma aktardığında, bu modülün Yardım konuları modülle birlikte oturuma aktarılır. Yardım konusu dosyalarını modül bildirimindeki FileList anahtarının değerinde listeleyebilirsiniz, ancak Yardım konuları cmdlet'inden Export-ModuleMember etkilenmez.

Modül Yardım konularını farklı dillerde sağlayabilirsiniz. Cmdlet, Get-Help Denetim Masası'ndaki Bölgesel ve Dil Seçenekleri öğesinde geçerli kullanıcı için belirtilen dilde modül Yardım konularını otomatik olarak görüntüler. Windows Vista ve windows'un sonraki sürümlerinde, Get-Help Windows için oluşturulan dil geri dönüş standartlarına uygun olarak modül dizininin dile özgü alt dizinlerinde Yardım konularını arar.

PowerShell 3.0'dan başlayarak, cmdlet veya işlev için bir Get-Help komut çalıştırmak modülün otomatik olarak içeri aktarılmasını tetikler. cmdlet'i Get-Help modüldeki yardım konularının içeriğini hemen görüntüler.

Modülde yardım konuları yoksa ve kullanıcının bilgisayarındaki modüldeki komutlar için yardım konuları yoksa, Get-Help otomatik olarak oluşturulan yardımı görüntüler. Otomatik olarak oluşturulan yardım komut söz dizimini, parametreleri, giriş ve çıkış türlerini içerir, ancak hiçbir açıklama içermez. Otomatik oluşturulan yardım, kullanıcıyı komutun yardımını internetten veya dosya paylaşımından indirmek üzere cmdlet'ini kullanmaya Update-Help yönlendiren metin içerir. Ayrıca, yardım konusunun çevrimiçi sürümünü almak için cmdlet'in Online parametresinin Get-Help kullanılmasını da önerir.

Güncelleştirilebilir Yardımı Destekleme

PowerShell'in PowerShell 3.0 ve sonraki sürümlerini kullananlar, bir modülün güncelleştirilmiş yardım dosyalarını internetten veya yerel bir dosya paylaşımından indirebilir ve yükleyebilir. ve Update-Help cmdlet'leri Save-Help yönetim ayrıntılarını kullanıcıdan gizler. Kullanıcılar cmdlet'ini Update-Help çalıştırır ve ardından powershell komut isteminde modülün en yeni yardım dosyalarını okumak için cmdlet'ini kullanır Get-Help . Kullanıcıların Windows veya PowerShell'i yeniden başlatması gerekmez.

Güvenlik duvarlarının arkasındaki kullanıcılar ve İnternet erişimi olmayan kullanıcılar da Güncelleştirilebilir Yardım'ı kullanabilir. İnternet erişimi olan yöneticiler, en yeni yardım dosyalarını indirip bir dosya paylaşımına yüklemek için cmdlet'ini kullanır Save-Help . Ardından kullanıcılar, dosya paylaşımından en yeni yardım dosyalarını almak için cmdlet'in Path parametresini Update-Help kullanır.

Modül yazarları modüle yardım dosyaları ekleyebilir ve yardım dosyalarını güncelleştirmek için Güncelleştirilebilir Yardım'ı kullanabilir veya modüldeki yardım dosyalarını atlayabilir ve hem yüklemek hem de güncelleştirmek için Güncelleştirilebilir Yardım'ı kullanabilir.

Güncelleştirilebilir Yardım hakkında daha fazla bilgi için bkz. Güncelleştirilebilir Yardım desteği.

Çevrimiçi Yardımı Destekleme

Güncelleştirilmiş yardım dosyalarını bilgisayarlarına yükleyemeyen veya yükleyemeyen kullanıcılar genellikle modül yardım konularının çevrimiçi sürümüne güvenir. Cmdlet'in Get-Help parametresi, varsayılan internet tarayıcısında kullanıcı için bir cmdlet'in çevrimiçi sürümünü veya gelişmiş işlev yardım konusunu açar.

Cmdlet, Get-Help yardım konusunun çevrimiçi sürümünü bulmak için cmdlet veya işlevin HelpUri özelliğinin değerini kullanır.

PowerShell 3.0'dan başlayarak, cmdlet sınıfında HelpUri özniteliğini veya CmdletBinding özniteliğinin HelpUri özelliğini tanımlayarak kullanıcıların cmdlet'in çevrimiçi sürümünü ve işlev yardım konularını bulmasına yardımcı olabilirsiniz. özniteliğinin değeri, cmdlet veya işlevin HelpUri özelliğinin değeridir.

Daha fazla bilgi için bkz . Çevrimiçi Yardımı Destekleme.

Ayrıca Bkz.

  • Last updated on