New-IseSnippet

  • Başvuru
Modül:
ISE

Bir Windows PowerShell ISE kod parçacığı oluşturur.

Syntax

New-IseSnippet
   [-Title] <String>
   [-Description] <String>
   [-Text] <String>
   [-Author <String>]
   [-CaretOffset <Int32>]
   [-Force]
   [<CommonParameters>]

Description

Cmdlet, New-ISESnippet Windows PowerShell ISE için yeniden kullanılabilir bir "kod parçacığı" oluşturur. Kod parçacıkları kullanarak Windows PowerShell ISE'de Betik bölmesine veya Komut bölmesine metin ekleyebilirsiniz. Bu cmdlet yalnızca Windows PowerShell ISE'de kullanılabilir.

Windows PowerShell 3.0 sürümünden başlayarak, Windows PowerShell ISE yerleşik kod parçacıkları koleksiyonu içerir. cmdlet'i New-ISESnippet , yerleşik koleksiyona eklemek için kendi kod parçacıklarınızı oluşturmanıza olanak tanır. Kod parçacığı dosyalarını görüntüleyebilir, değiştirebilir, ekleyebilir, silebilir ve paylaşabilir ve bunları Windows PowerShell modüllerine ekleyebilirsiniz. Windows PowerShell ISE'de kod parçacıklarını görmek için Düzenle menüsünden Kod Parçacıklarını Başlat'ı seçin veya CTRL+J tuşuna basın.

cmdlet'i New-ISESnippet dizinde $HOME\Documents\WindowsPowerShell\Snippets belirttiğiniz başlıkla bir <Title>.Snippets.ps1xml dosya oluşturur. Yazmakta olduğunuz bir modüle kod parçacığı dosyası eklemek için kod parçacığı dosyasını modül dizininizin Kod Parçacıkları alt dizinine ekleyin.

Kullanıcı tarafından oluşturulan kod parçacıklarını, yürütme ilkesinin Kısıtlı veya AllSigned olduğu bir oturumda kullanamazsınız.

Bu cmdlet, Windows PowerShell 3.0'da kullanıma sunulmuştur.

Örnekler

Örnek 1: Açıklama Tabanlı yardım parçacığı oluşturma

New-IseSnippet -Title Comment-BasedHelp -Description "A template for comment-based help." -Text "<#
    .SYNOPSIS

    .DESCRIPTION
    .PARAMETER  <Parameter-Name>
    .INPUTS
    .OUTPUTS
    .EXAMPLE
    .LINK
#>"

Bu komut, Windows PowerShell ISE için Comment-BasedHelp kod parçacığı oluşturur. Kullanıcının Kod Parçacıkları dizininde $HOME\Documents\WindowsPowerShell\Snippetsadlı Comment-BasedHelp.snippets.ps1xml bir dosya oluşturur.

Örnek 2: Zorunlu kod parçacığı oluşturma

$M = @'
Param
(
  [parameter(Mandatory=$true)]
  [String[]]
  $<ParameterName>
)
'@

New-ISESnippet -Text $M -Title Mandatory -Description "Adds a mandatory function parameter." -Author "Patti Fuller, Fabrikam Corp." -Force

Bu örnek, Windows PowerShell ISE için Zorunlu adlı bir kod parçacığı oluşturur. İlk komut kod parçacığı metnini değişkene $M kaydeder. İkinci komut, kod parçacığını New-ISESnippet oluşturmak için cmdlet'ini kullanır. komutu, aynı ada sahip önceki bir kod parçacığının üzerine yazmak için Force parametresini kullanır.

Örnek 3: Zorunlu kod parçacığını bir klasörden hedef klasöre kopyalama

Copy-Item "$HOME\Documents\WindowsPowerShell\Snippets\Mandatory.Snippets.ps1xml" -Destination "\\Server\Share"

Bu komut cmdlet'ini kullanarak Copy-Item Zorunlu kod parçacığını Sunucu\Paylaş dosya paylaşımına yerleştirdiği New-ISESnippet klasörden kopyalar.

Parametreler

-Author

Kod parçacığının yazarını belirtir. Yazar alanı kod parçacığı dosyasında görünür, ancak Windows PowerShell ISE'de kod parçacığı adına tıkladığınızda görünmez.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CaretOffset

Bu cmdlet'in imleci üzerine yerleştirdiğini kod parçacığı metninin karakterini belirtir. İmleç konumunu temsil eden ve metnin ilk karakterini temsil eden "1" ile birlikte bir tamsayı girin. Varsayılan değer olan 0 (sıfır), imleci metnin ilk karakterinin hemen önüne yerleştirir. Bu parametre kod parçacığı metnini girintilemez.

Type:Int32
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Kod parçacığının açıklamasını belirtir. Açıklama değeri, Windows PowerShell ISE'de kod parçacığı adına tıkladığınızda görüntülenir. Bu parametre zorunludur.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Force

Bu cmdlet'in aynı konumda aynı ada sahip kod parçacığı dosyalarının üzerine yazdığını gösterir. Varsayılan olarak, New-ISESnippet dosyaların üzerine yazmaz.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Text

Kod parçacığını seçtiğinizde eklenen metin değerini belirtir. Kod parçacığı metni, Windows PowerShell ISE'de kod parçacığı adına tıkladığınızda görünür. Bu parametre zorunludur.

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Title

Kod parçacığı için bir başlık veya ad belirtir. Başlık, kod parçacığı dosyasını da adlandırın. Bu parametre zorunludur.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Girişler

None

Nesneleri bu cmdlet'e yöneltemezsiniz.

Çıkışlar

None

Bu cmdlet çıkış döndürmez.

Notlar

New-IseSnippet kullanıcı tarafından oluşturulan yeni kod parçacıklarını imzasız .ps1xml dosyalarında depolar. Bu nedenle, Windows PowerShell bunları yürütme ilkesinin AllSigned veya Restricted olduğu bir oturuma ekleyemez. Kısıtlı veya AllSigned oturumunda, imzalanmamış kullanıcı tarafından oluşturulan kod parçacıkları oluşturabilir, alabilir ve içeri aktarabilirsiniz, ancak bunları oturumda kullanamazsınız.

Cmdlet'i Kısıtlı veya AllSigned oturumunda kullanıyorsanız New-IseSnippet kod parçacığı oluşturulur, ancak Windows PowerShell yeni oluşturulan kod parçacığını oturuma eklemeye çalıştığında bir hata iletisi görüntülenir. Yeni kod parçacığını (ve diğer imzalanmamış kullanıcı tarafından oluşturulan kod parçacıklarını) kullanmak için yürütme ilkesini değiştirin ve ardından Windows PowerShell ISE'yi yeniden başlatın.

Windows PowerShell yürütme ilkeleri hakkında daha fazla bilgi için bkz . about_Execution_Policies.

  • Kod parçacığını değiştirmek için kod parçacığı dosyasını düzenleyin. Kod parçacığı dosyalarını Windows PowerShell ISE'nin Betik bölmesinde düzenleyebilirsiniz.
  • Eklediğiniz bir kod parçacığını silmek için kod parçacığı dosyasını silin.
  • Yerleşik bir kod parçacığını silemezsiniz, ancak "$psise kullanarak tüm yerleşik kod parçacıklarını gizleyebilirsiniz. Options.ShowDefaultSnippets=$false" komutu.
  • Yerleşik kod parçacığıyla aynı ada sahip bir kod parçacığı oluşturabilirsiniz. Her iki kod parçacığı da Windows PowerShell ISE'deki kod parçacığı menüsünde görünür.