Fonksiyonlar_Hakkında

Kısa açıklama

PowerShell'de işlevlerin nasıl oluşturulacağını ve kullanılacağını açıklar.

Uzun açıklama

İşlev, atadığınız bir ada sahip PowerShell deyimlerinin listesidir. Bir işlevi çalıştırdığınızda işlev adını yazarsınız.

PowerShell iki işlev türünü tanımlar:

• İşlev, ada göre çağrılabilen bir kod bloğudur. Giriş alabilir ve çıkış döndürebilir. İşlevler anahtar sözcüğü kullanılarak function tanımlanır.
• Filtre, işlem hattından verileri işlemek için tasarlanmış bir işlev türüdür. Filtreler anahtar sözcüğü kullanılarak filter tanımlanır.

Bir işlevdeki deyimleri önceden tanımlanmış dört farklı deyim bloğundan birinde gruplandırabilirsiniz. Bu deyim blokları begin, , processendve cleananahtar sözcükleri kullanılarak adlandırılır. Bu anahtar sözcükleri kullanmıyorsanız PowerShell deyimlerini uygun kod bloğuna yerleştirir.

İşlevler cmdlet'ler gibi de hareket edebilir. C# programlama kullanmadan bir cmdlet gibi çalışan bir işlev oluşturabilirsiniz. Daha fazla bilgi için bkz. about_Functions_Advanced.

Önemli

Betik dosyaları ve betik tabanlı modüller içinde işlevlerin çağrılabilmesi için önce tanımlanması gerekir.

İşlev söz dizimi

İşlevler aşağıdaki söz dizimi kullanılarak tanımlanır:

function [<scope:>]<name> {
  param([type]$Parameter1 [,[type]$Parameter2])
  dynamicparam {<statement list>}
  begin {<statement list>}
  process {<statement list>}
  end {<statement list>}
  clean {<statement list>}
}

İşlev aşağıdaki öğeleri içerir:

• function anahtar sözcüğü
• Kapsam (isteğe bağlı)
• Seçtiğiniz bir ad
• Dinamik parametreler de dahil olmak üzere herhangi bir sayıda adlandırılmış parametre (isteğe bağlı)
• Küme ayraçları içine alınmış bir veya daha fazla PowerShell deyimi {}

Bir tanımda begin (process, end, clean, function) anahtar sözcüklerinden birini kullanmazsanız PowerShell deyimleri bloğa end yerleştirir.

İşlevlerdeki dynamicparam anahtar sözcüğü ve dinamik parametreler hakkında daha fazla bilgi için bkz. about_Functions_Advanced_Parameters.

bir işlev aşağıdaki kadar basit olabilir:

function Get-PowerShellProcess { Get-Process pwsh }

İşlev tanımlandıktan sonra yerleşik cmdlet'ler gibi kullanabilirsiniz. Örneğin, yeni tanımlanan Get-PowerShellProcess işlevini çağırmak için:

Get-PowerShellProcess

 NPM(K)    PM(M)      WS(M)     CPU(s)      Id  SI ProcessName
 ------    -----      -----     ------      --  -- -----------
    110    78.72     172.39      10.62   10936   1 pwsh

Bir işlev, cmdlet'i kadar karmaşık da olabilir.

İşlevler görüntülenebilir, değişkenlere atanabilir veya diğer işlevlere veya cmdlet'lere geçirilebilen değerler döndürebilir. Çıkış döndürmek için anahtar sözcüğünü return kullanabilirsiniz. return anahtar sözcüğü işlevinizden döndürülen diğer çıkışı etkilemez veya gizlemez. Ancak, return anahtar sözcüğü bu satırdaki işlevden çıkar. Daha fazla bilgi için bkz. about_Return.

Filtre söz dizimi

İşlevin amacı, işlem hattındaki filter her nesne üzerinde çalışan bir işlev tanımlamanın kısa bir yolunu sağlamaktır.

Filtrenin söz dizimi aşağıdaki gibidir:

filter [<scope:>]<name> {<statement list>}

İşlevlerin söz dizimini basitleştirmek için filter deyimi block anahtar sözcüğünü (begin, process, , endclean) atlayın. PowerShell, deyimlerini bloğa process yerleştirir. Filtre işlevindeki diğer bloklardan herhangi birini kullanabilirsiniz, ancak amaç, tek amacı işlem hattındaki her nesneyi işlemek olan bir işlev tanımlamanın kısa bir yolunu sağlamaktı.

Aşağıdaki filtre işlem hattından günlük girdilerini alır ve girişin tamamını veya yalnızca ileti bölümünü görüntüler:

filter Get-EventMessage ([switch]$MessageOnly) {
  if ($MessageOnly) { Out-Host -InputObject $_.Message }
  else { $_ }
}

Aşağıdaki gibi kullanılabilir:

Get-WinEvent -LogName System -MaxEvents 100 | Get-EventMessage -MessageOnly

Giriş işleme yöntemleri

Bu bölümde açıklanan yöntemler giriş işleme yöntemleri olarak adlandırılır. İşlevler için, işlevinin begin, processve end bloklarını kullanarak adlı bu üç yöntem. PowerShell 7.3 bir clean blok işlemi yöntemi ekler.

İşlevlerinizde bu bloklardan herhangi birini kullanmanız gerekmez. Adlandırılmış blok kullanmıyorsanız PowerShell kodu işlevin end bloğuna yerleştirir. Ancak, bu adlandırılmış bloklardan herhangi birini kullanırsanız veya bir dynamicparam bloğu tanımlarsanız, tüm kodu adlandırılmış bir bloğa yerleştirmeniz gerekir.

Aşağıdaki örnekte, tek seferlik ön işleme için bir begin blok, process işlem hattından blok verileri ve tek seferlik işlem sonrası için bir blok içeren bir end işlevin ana hattı gösterilmektedir.

Function Test-ScriptCmdlet {
    [CmdletBinding(SupportsShouldProcess=$true)]
    param ($Parameter1)
    begin{}
    process{}
    end{}
}

begin

Bu blok, işlev için isteğe bağlı bir kerelik ön işleme sağlamak için kullanılır. PowerShell çalışma zamanı, işlem hattındaki işlevin her örneği için bu bloktaki kodu bir kez kullanır.

process

Bu blok, işlev için kayıt kaydı işleme sağlamak için kullanılır. Diğer blokları tanımlamadan bir process bloğu kullanabilirsiniz. process blok yürütmelerinin sayısı, işlevi nasıl kullandığınıza ve işlevin hangi girişi aldığına bağlıdır.

$_ veya $PSItem otomatik değişkeni, process bloğunda kullanılmak üzere işlem hattındaki geçerli nesneyi içerir. Otomatik $input değişken, yalnızca işlevler ve betik blokları için kullanılabilen bir numaralandırıcı içerir. Daha fazla bilgi için bkz. about_Automatic_Variables.

• İşlev işlem hattı girişi olmadan çağrılırsa PowerShell bloğu yalnızca bir kez yürütür process .
• bir işlem hattı içinde, işleve ulaşan her giriş nesnesi için process bloğu bir kez yürütülür.
• İşleve ulaşan işlem hattı girişi boşsa blok process yürütülmüyordur.
  • begin, endve clean blokları hala yürütülür.

Önemli

İşlev parametresi işlem hattı girişini kabul ederse ve bir process blok tanımlanmamışsa, kayıt kaydı işleme başarısız olur. Bu durumda, işleviniz giriş ne olursa olsun yalnızca bir kez yürütülür.

end

İşlev için isteğe bağlı bir kerelik işlem sonrası sağlamak için bu bloğu kullanın.

clean

clean bloğu PowerShell 7.3'e eklendi.

clean bloğu, kullanıcıların begin, processve end bloklarına yayılan kaynakları temizlemesi için kullanışlı bir yoldur. Bir betik işlevinin veya betik cmdlet'inin diğer tüm adlandırılmış bloklarını kapsayan finally bloğuna benzer. Kaynak temizleme aşağıdaki senaryolar için zorunlu kılındı:

1. işlem hattı yürütmesi sonlandırılmadan tamamlandığında hata
2. sonlandırma hatası nedeniyle işlem hattı yürütmesi kesintiye uğradığında
3. işlem hattı kesildiğinde, örneğin: Select-Object -First
4. işlem hattı Ctrl+c veya tarafından durdurulduğunda StopProcessing()

Temiz blok, Success akışına yazılan tüm çıktıları atar.

Dikkat

clean bloğunun eklenmesi hataya neden olan bir değişikliktir. clean Anahtar sözcük olarak ayrıştırıldığından, kullanıcıların betik bloğundaki ilk deyim olarak adlandırılan clean bir komutu doğrudan çağırmasını engeller. Ancak, büyük olasılıkla bir sorun olmayacaktır. Komutunu çağırma işlecini (& clean kullanarak da çağırabilirsiniz.

Basit işlevler

İşlevlerin yararlı olması için karmaşık olması gerekmez. En basit işlevler aşağıdaki biçime sahiptir:

function <function-name> { statements }

Örneğin, aşağıdaki işlev PowerShell'i Yönetici olarak çalıştır seçeneğiyle başlatır.

function Start-PSAdmin { Start-Process PowerShell -Verb RunAs }

işlevini kullanmak için şunu yazın: Start-PSAdmin

İşleve deyim eklemek için her deyimi ayrı bir satıra yazın veya deyimleri ayırmak için noktalı virgül (;) kullanın.

Örneğin, aşağıdaki işlev geçerli kullanıcının dizinlerindeki başlangıç tarihinden sonra değiştirilen tüm .jpg dosyalarını bulur.

function Get-NewPicture {
  $start = Get-Date -Month 1 -Day 1 -Year 2010
  $allPics = Get-ChildItem -Path $Env:USERPROFILE\*.jpg -Recurse
  $allPics | Where-Object {$_.LastWriteTime -gt $Start}
}

Kullanışlı küçük işlevlerden oluşan bir araç kutusu oluşturabilirsiniz. Bu işlevleri, bu makalenin about_Profiles ve sonraki bölümlerinde açıklandığı gibi PowerShell profilinize ekleyin.

İşlev adları

bir işleve herhangi bir ad atayabilirsiniz. Ancak başkalarıyla paylaştığınız işlevler için standart PowerShell adlandırma kurallarına uymanız gerekir.

• Adlar, fiilin işlevin gerçekleştirdiği eylemi, isim ise cmdlet'in eylemi gerçekleştirdiği öğeyi tanımladığı bir fiil-isim çifti içermelidir.
• Adlar, tüm PowerShell komutları için onaylanan fiilleri kullanmalıdır. Onaylanan fiillerin kullanılması kullanıcılar için tutarlılık oluşturur.

Standart PowerShell fiilleri hakkında daha fazla bilgi için bkz. Onaylı Fiiller.

Parametreleri olan işlevler

Adlandırılmış parametreler, konumsal parametreler, anahtar parametreleri ve dinamik parametreler dahil olmak üzere işlevlerle parametreleri kullanabilirsiniz. İşlevlerdeki dinamik parametreler hakkında daha fazla bilgi için bkz. about_Functions_Advanced_Parameters.

Adlandırılmış parametreler

İstediğiniz sayıda adlandırılmış parametre tanımlayabilirsiniz. Bu makalenin devamında açıklandığı gibi adlandırılmış parametreler için varsayılan bir değer ekleyebilirsiniz.

Aşağıdaki örnek söz diziminde gösterildiği gibi param anahtar sözcüğünü kullanarak küme ayraçlarının içinde parametreler tanımlayabilirsiniz:

function <name> {
  param ([type]$Parameter1 [,[type]$Parameter2])
  <statement list>
}

Aşağıdaki örnek söz diziminde gösterildiği gibi, param anahtar sözcüğü olmadan ayraçların dışında parametreler de tanımlayabilirsiniz:

function <name> [([type]$Parameter1[,[type]$Parameter2])] {
  <statement list>
}

Örneğin, aşağıdaki işlev iki parametre tanımlamak için alternatif söz dizimini kullanır:

function Add-Numbers([int]$One, [int]$Two) {
    $One + $Two
}

İlk yöntem tercih edilirken, bu iki yöntem arasında bir fark yoktur.

İşlevi çalıştırdığınızda, parametre için sağladığınız değer parametre adını içeren bir değişkene atanır. Bu değişkenin değeri işlevde kullanılabilir.

Aşağıdaki örnek, Get-SmallFilesadlı bir işlevdir. Bu işlevin $Size parametresi vardır. işlevi, $Size parametresinin değerinden daha küçük olan tüm dosyaları görüntüler ve dizinleri dışlar:

function Get-SmallFiles {
  param ($Size)
  Get-ChildItem $HOME | Where-Object {
    $_.Length -lt $Size -and !$_.PSIsContainer
  }
}

işlevinde parametresi için tanımlanan ad olan $Size değişkenini kullanabilirsiniz.

Bu işlevi kullanmak için aşağıdaki komutu yazın:

Get-SmallFiles -Size 50

Ayrıca, parametre adı olmadan adlandırılmış parametre için bir değer de girebilirsiniz. Örneğin, aşağıdaki komut Boyutu parametresini adlandıran bir komutla aynı sonucu verir:

Get-SmallFiles 50

Parametre için varsayılan bir değer tanımlamak için, Get-SmallFiles örneğin aşağıdaki varyasyonunda gösterildiği gibi, parametre adından sonra bir eşittir işareti ve değeri yazın:

function Get-SmallFiles ($Size = 100) {
  Get-ChildItem $HOME | Where-Object {
    $_.Length -lt $Size -and !$_.PSIsContainer
  }
}

Get-SmallFiles bir değer olmadan yazarsanız, işlevi $size100 atar. Bir değer sağlarsanız işlev bu değeri kullanır.

İsteğe bağlı olarak, parametrenizin açıklamasına PSDefaultValue özniteliğini ekleyerek ve PSDefaultValueYardım özelliğini belirterek parametrenizin varsayılan değerini açıklayan kısa bir yardım dizesi sağlayabilirsiniz. işlevindeki Get-SmallFiles parametresinin varsayılan değerini (100) açıklayan bir yardım dizesi sağlamak için, aşağıdaki örnekte gösterildiği gibi PSDefaultValue özniteliğini ekleyin.

function Get-SmallFiles {
  param (
      [PSDefaultValue(Help = '100')]
      $Size = 100
  )
  Get-ChildItem $HOME | Where-Object {
    $_.Length -lt $Size -and !$_.PSIsContainer
  }
}

PSDefaultValue öznitelik sınıfı hakkında daha fazla bilgi için bkz. PSDefaultValue Öznitelik Üyeleri.

Konumsal parametreler

Konumsal parametre, parametre adı olmayan bir parametredir. PowerShell, her parametre değerini işlevdeki bir parametreyle ilişkilendirmek için parametre değeri sırasını kullanır.

Konumsal parametreler kullandığınızda, işlev adından sonra bir veya daha fazla değer yazın. Konumsal parametre değerleri $args dizi değişkenine atanır. İşlev adını izleyen değer, $args dizisindeki ilk konuma $args[0]atanır.

Aşağıdaki Get-Extension işlevi, .txt dosya adı uzantısını sağladığınız bir dosya adına ekler:

function Get-Extension {
  $name = $args[0] + ".txt"
  $name
}

Get-Extension myTextFile

myTextFile.txt

Parametreleri değiştirme

Anahtar, değer gerektirmeyen bir parametredir. Bunun yerine işlev adını ve ardından switch parametresinin adını yazarsınız.

Anahtar parametresi tanımlamak için, aşağıdaki örnekte gösterildiği gibi parametre adından önce [switch] türünü belirtin:

function Switch-Item {
  param ([switch]$On)
  if ($On) { "Switch on" }
  else { "Switch off" }
}

İşlev adından sonra On switch parametresini yazdığınızda, işlev Switch ongörüntüler. switch parametresi olmadan Switch offgörüntüler.

Switch-Item -On

Switch on

Switch-Item

Switch off

Aşağıdaki örnekte gösterildiği gibi işlevi çalıştırdığınızda bir anahtara Boole değeri de atayabilirsiniz:

Switch-Item -On:$true

Switch on

Switch-Item -On:$false

Switch off

Parametre değerlerini geçirmek için splatting kullanma

Bir komutun parametrelerini temsil etmek için splatting kullanabilirsiniz. Bu özellik Windows PowerShell 3.0'da kullanıma sunulmuştur.

Oturumdaki komutları çağıran işlevlerde bu tekniği kullanın. Komut parametrelerini bildirmeniz veya listelemeniz veya komut parametreleri değiştiğinde işlevi değiştirmeniz gerekmez.

Aşağıdaki örnek işlev Get-Command cmdlet'ini çağırır. komutu, @argsparametrelerini göstermek için Get-Command kullanır.

function Get-MyCommand { Get-Command @args }

Get-Command işlevini çağırdığınızda Get-MyCommand tüm parametrelerini kullanabilirsiniz. parametreler ve parametre değerleri @argskullanılarak komutuna geçirilir.

Get-MyCommand -Name Get-ChildItem

CommandType     Name                ModuleName
-----------     ----                ----------
Cmdlet          Get-ChildItem       Microsoft.PowerShell.Management

@args özelliği, bildirilmemiş cmdlet parametrelerini ve kalan bağımsız değişkenlerdeki değerleri temsil eden $args otomatik parametresini kullanır.

Daha fazla bilgi için bkz. about_Splatting.

Nesneleri işlevlere borulama

Herhangi bir işlev işlem hattından giriş alabilir. begin, process, endve clean anahtar sözcükleri kullanarak bir işlevin işlem hattından gelen girişleri nasıl işlediğini denetleyebilirsiniz. Aşağıdaki örnek söz dizimi şu anahtar sözcükleri gösterir:

process deyimi listesi, işlem hattındaki her nesne için bir kez çalışır. process bloğu çalışırken, her işlem hattı nesnesi $_ otomatik değişkenine atanır ve her seferinde bir işlem hattı nesnesi olur.

Aşağıdaki işlev process anahtar sözcüğünü kullanır. İşlev işlem hattındaki değerleri görüntüler:

function Get-Pipeline
{
  process {"The value is: $_"}
}

1, 2, 4 | Get-Pipeline

The value is: 1
The value is: 2
The value is: 4

Bir parametreden işlem hattı girişi veya girişi alabilen bir işlev istiyorsanız, process bloğunun her iki durumu da işlemesi gerekir. Mesela:

function Get-SumOfNumbers {
    param (
        [int[]]$Numbers
    )

    begin { $retValue = 0 }

    process {
        if ($MyInvocation.ExpectingInput) {
           "Pipeline input: $_"
           $retValue += $_
        } else {
           foreach ($n in $Numbers) {
               "Command line input: $n"
               $retValue += $n
           }
        }
    }

    end { "Sum = $retValue" }
}


PS> 1,2,3,4 | Get-SumOfNumbers
Pipeline input: 1
Pipeline input: 2
Pipeline input: 3
Pipeline input: 4
Sum = 10
PS> Get-SumOfNumbers 1,2,3,4
Command line input: 1
Command line input: 2
Command line input: 3
Command line input: 4
Sum = 10

İşlem hattında bir işlev kullandığınızda, işleve yöneltilen nesneler $input otomatik değişkenine atanır. İşlev, işlem hattından herhangi bir nesne gelmeden önce deyim bloğuyla begin deyimleri çalıştırır. İşlev, işlem hattında end başka nesne olmadığında deyim bloğuyla deyimleri çalıştırır.

Aşağıdaki örnekte, ve end deyimi bloklarında begin kullanılan otomatik değişken gösterilmektedir$input.

function Get-PipelineBeginEnd {
    begin   { "Begin: The input is $input" }
    end     { "End:   The input is $input" }
}

İşlevi işlem hattı girişiyle çalıştırdığınızda aşağıdaki sonuçlar görüntülenir:

1, 2, 4 | Get-PipelineBeginEnd

Begin: The input is
End:   The input is 1 2 4

begin deyimi çalıştırıldığında işlev işlem hattından gelen girişe sahip olmaz. end deyimi, işlev değerlerine sahip olduktan sonra çalışır.

İşlevin process bir anahtar sözcüğü varsa, $input içindeki her nesne $input kaldırılır ve $_atanır. Aşağıdaki örnekte bir process deyimi listesi vardır:

function Get-PipelineInput
{
    process {"Processing:  $_ " }
    end     {"End:   The input is: $input" }
}

Bu örnekte, işleve yöneltilen her nesne deyim listesine gönderilir process . process deyimleri her nesne üzerinde çalışır ve her seferinde bir nesnedir. İşlev $input anahtar sözcüğüne ulaştığında end otomatik değişkeni boş olur.

1, 2, 4 | Get-PipelineInput

Processing:  1
Processing:  2
Processing:  4
End:   The input is:

Daha fazla bilgi için bkz. Numaralandırmaları Kullanma

PowerShell 7.3, clean bloğunu ekledi. clean bloğu, kullanıcıların begin, processve end bloklarında oluşturulan ve kullanılan kaynakları temizlemesi için kullanışlı bir yoldur. Bir betik işlevinin veya betik cmdlet'inin diğer tüm adlandırılmış bloklarını kapsayan finally bloğuna benzer. Kaynak temizleme aşağıdaki senaryolar için zorunlu kılındı:

1. işlem hattı yürütmesi sonlandırılmadan normal şekilde tamamlandığında hata
2. sonlandırma hatası nedeniyle işlem hattı yürütmesi kesintiye uğradığında
3. işlem hattı kesildiğinde, örneğin: Select-Object -First
4. işlem hattı Ctrl+C veya StopProcessing()

Dikkat

clean bloğunun eklenmesi hataya neden olan bir değişikliktir. clean Anahtar sözcük olarak ayrıştırıldığından, kullanıcıların betik bloğundaki ilk deyim olarak adlandırılan clean bir komutu doğrudan çağırmasını engeller. Ancak, büyük olasılıkla bir sorun olmayacaktır. Komut hala çağrı işleci (& clean) kullanılarak çağrılabilir.

İşlev kapsamı

Bir işlev, oluşturduğunuz kapsamda bulunur.

İşlev bir betiğin parçasıysa, işlev bu betik içindeki deyimler için kullanılabilir. Varsayılan olarak, betikteki bir işlev bu betiğin dışında kullanılamaz.

bir işlevin kapsamını belirtebilirsiniz. Örneğin, işlev aşağıdaki örnekte genel kapsama eklenir:

function Global:Get-DependentSvs {
  Get-Service | Where-Object {$_.DependentServices}
}

bir işlev genel kapsamda olduğunda, işlevi betiklerde, işlevlerde ve komut satırında kullanabilirsiniz.

İşlevler yeni bir kapsam oluşturur. Bir işlevde oluşturulan değişkenler gibi öğeler yalnızca işlev kapsamında bulunur.

Daha fazla bilgi için bkz. about_Scopes.

Sürücüyü kullanarak Function: işlevleri bulma ve yönetme

PowerShell'deki tüm işlevler ve filtreler otomatik olarak Function: sürücüsünde depolanır. Bu sürücü PowerShell İşlevi sağlayıcısı tarafından kullanıma sunulur.

Function: sürücüye başvururken, veya C sürücüsüne başvururken yaptığınız gibi Dsonra iki nokta üst üste yazın.

Aşağıdaki komut, PowerShell'in geçerli oturumundaki tüm işlevleri görüntüler:

Get-ChildItem Function:

İşlevdeki komutlar, işlevin tanım özelliğinde betik bloğu olarak depolanır. Örneğin, PowerShell ile birlikte gelen Yardım işlevindeki komutları görüntülemek için şunu yazın:

(Get-ChildItem Function:help).Definition

Aşağıdaki söz dizimini de kullanabilirsiniz.

$Function:help

Daha fazla bilgi için bkz. about_Function_Provider.

İşlevleri yeni oturumlarda yeniden kullanma

PowerShell komut isteminde bir işlev yazdığınızda, işlev geçerli oturumun bir parçası olur. İşlev, oturum sona erene kadar kullanılabilir.

İşlevinizi tüm PowerShell oturumlarında kullanmak için işlevi PowerShell profilinize ekleyin. Profiller hakkında daha fazla bilgi için bkz. about_Profiles.

İşlevinizi bir PowerShell betik dosyasına da kaydedebilirsiniz. İşlevinizi bir metin dosyasına yazın ve dosyayı .ps1 dosya adı uzantısıyla kaydedin.

İşlevler için yardım oluşturma

cmdlet'i Get-Help işlevler, cmdlet'ler, sağlayıcılar ve betikler için yardım alır. İşlevle ilgili yardım almak için Get-Help yazın ve ardından işlev adını yazın.

Örneğin, Get-MyDisks işleviyle ilgili yardım almak için şunu yazın:

Get-Help Get-MyDisks

Aşağıdaki iki yöntemden birini kullanarak bir işlev için yardım yazabilirsiniz:

• İşlevler için Comment-Based Yardımı

  Açıklamalarda özel anahtar sözcükleri kullanarak yardım oluşturun. Bir işlev için açıklama tabanlı yardım oluşturmak için, açıklamaların işlevin başına, sonuna veya gövdesine yerleştirilmesi gerekir. Açıklama tabanlı yardım hakkında daha fazla bilgi için bkz. about_Comment_Based_Help.

• İşlevler için XML-Based Yardımı

  Yardım içeriğini birden çok dilde yerelleştirmeniz gerekiyorsa XML tabanlı yardım gereklidir. İşlevi XML tabanlı yardım dosyasıyla ilişkilendirmek için açıklama tabanlı yardım anahtar sözcüğünü .EXTERNALHELP kullanın. Bu anahtar sözcük olmadan işlev Get-Help yardım dosyasını bulamıyor ve yalnızca otomatik olarak oluşturulan yardımı döndürüyor.

  .EXTERNALHELP anahtar sözcüğü hakkında daha fazla bilgi için bkz. about_Comment_Based_Help. XML tabanlı yardım hakkında daha fazla bilgi için bkz. Cmdlet'i Yazma Yardımı.

Ayrıca bakınız

• Otomatik_Değişkenler_Hakkında
• Yorum Tabanlı Yardım Hakkında
• about_Function_Provider
• işlevler_hakkında_Gelişmiş
• İşlevler_Hakkında_Gelişmiş_Yöntemler
• fonksiyonlar_hakkında_İleri_Düzey_Parametreler
• Functions_CmdletBindingAttribute Hakkında
• about_Functions_OutputTypeAttribute
• parametreler_hakkında
• Profiller_Hakkında
• kapsamlar_hakkinda
• Script_Blokları_Hakkında