New-IseSnippet

  • Referensi
Modul:
ISE

Membuat cuplikan kode ISE Windows PowerShell.

Sintaks

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

Deskripsi

New-ISESnippet Cmdlet membuat "cuplikan" teks yang dapat digunakan kembali untuk Windows PowerShell ISE. Anda bisa menggunakan cuplikan untuk menambahkan teks ke panel Skrip atau panel Perintah di Windows PowerShell ISE. Cmdlet ini hanya tersedia di Windows PowerShell ISE.

Dimulai di Windows PowerShell 3.0, WINDOWS PowerShell ISE menyertakan kumpulan cuplikan bawaan. New-ISESnippet Cmdlet memungkinkan Anda membuat cuplikan Anda sendiri untuk ditambahkan ke koleksi bawaan. Anda dapat melihat, mengubah, menambahkan, menghapus, dan berbagi file cuplikan dan menyertakannya dalam modul Windows PowerShell. Untuk melihat cuplikan di Windows PowerShell ISE, dari menu Edit, pilih Mulai Cuplikan atau tekan CTRL+J.

New-ISESnippet Cmdlet membuat <Title>.Snippets.ps1xml file di $HOME\Documents\WindowsPowerShell\Snippets direktori dengan judul yang Anda tentukan. Untuk menyertakan file cuplikan dalam modul yang Anda tulis, tambahkan file cuplikan ke subdirektori Cuplikan direktori modul Anda.

Anda tidak dapat menggunakan cuplikan yang dibuat pengguna dalam sesi di mana kebijakan eksekusi Dibatasi atau AllSigned.

Cmdlet ini diperkenalkan di Windows PowerShell 3.0.

Contoh

Contoh 1: Membuat cuplikan bantuan Berbasis Komentar

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

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

Perintah ini membuat cuplikan Comment-BasedHelp untuk Windows PowerShell ISE. Ini membuat file bernama Comment-BasedHelp.snippets.ps1xml di direktori $HOME\Documents\WindowsPowerShell\SnippetsCuplikan pengguna .

Contoh 2: Membuat cuplikan wajib

$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

Contoh ini membuat cuplikan bernama Wajib untuk Windows PowerShell ISE. Perintah pertama menyimpan teks cuplikan $M dalam variabel. Perintah kedua menggunakan New-ISESnippet cmdlet untuk membuat cuplikan. Perintah menggunakan parameter Paksa untuk menimpa cuplikan sebelumnya dengan nama yang sama.

Contoh 3: Menyalin cuplikan wajib dari folder ke folder tujuan

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

Perintah ini menggunakan Copy-Item cmdlet untuk menyalin cuplikan Wajib dari folder tempat New-ISESnippet menempatkannya ke berbagi file Server\Share.

Parameter

-Author

Menentukan penulis cuplikan. Bidang pembuat muncul di file cuplikan, tetapi tidak muncul saat Anda mengklik nama cuplikan di Windows PowerShell ISE.

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

-CaretOffset

Menentukan karakter teks cuplikan tempat cmdlet ini menempatkan kursor. Masukkan bilangan bulat yang mewakili posisi kursor, dengan "1" mewakili karakter teks pertama. Nilai default, 0 (nol), menempatkan kursor segera sebelum karakter teks pertama. Parameter ini tidak mengindentasi teks cuplikan.

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

-Description

Menentukan deskripsi cuplikan. Nilai deskripsi muncul saat Anda mengklik nama cuplikan di Windows PowerShell ISE. Parameter ini diperlukan.

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

-Force

Menunjukkan bahwa cmdlet ini menimpa file cuplikan dengan nama yang sama di lokasi yang sama. Secara default, New-ISESnippet tidak menimpa file.

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

-Text

Menentukan nilai teks yang ditambahkan saat Anda memilih cuplikan. Teks cuplikan muncul saat Anda mengklik nama cuplikan di Windows PowerShell ISE. Parameter ini diperlukan.

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

-Title

Menentukan judul atau nama untuk cuplikan. Judul juga menamai file cuplikan. Parameter ini diperlukan.

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

Input

None

Anda tidak dapat menyalurkan objek ke cmdlet ini.

Output

None

Cmdlet ini tidak mengembalikan output.

Catatan

New-IseSnippet menyimpan cuplikan baru yang dibuat pengguna dalam file .ps1xml yang tidak ditandatangani. Dengan demikian, Windows PowerShell tidak dapat menambahkannya ke sesi di mana kebijakan eksekusi AllSigned atau Restricted. Dalam sesi Terbatas atau AllSigned, Anda dapat membuat, mendapatkan, dan mengimpor cuplikan yang dibuat pengguna yang tidak ditandatangani, tetapi Anda tidak dapat menggunakannya dalam sesi.

Jika Anda menggunakan New-IseSnippet cmdlet dalam sesi Terbatas atau AllSigned, cuplikan dibuat, tetapi pesan kesalahan muncul ketika Windows PowerShell mencoba menambahkan cuplikan yang baru dibuat ke sesi. Untuk menggunakan cuplikan baru (dan cuplikan lain yang dibuat pengguna yang tidak ditandatangani), ubah kebijakan eksekusi, lalu mulai ulang Windows PowerShell ISE.

Untuk informasi selengkapnya tentang kebijakan eksekusi Windows PowerShell, lihat about_Execution_Policies.

  • Untuk mengubah cuplikan, edit file cuplikan. Anda dapat mengedit file cuplikan di panel Skrip Windows PowerShell ISE.
  • Untuk menghapus cuplikan yang Anda tambahkan, hapus file cuplikan.
  • Anda tidak dapat menghapus cuplikan bawaan, tetapi Anda dapat menyembunyikan semua cuplikan bawaan dengan menggunakan "$psise. Opsi.ShowDefaultSnippets=$false" perintah.
  • Anda dapat membuat cuplikan yang memiliki nama yang sama dengan cuplikan bawaan. Kedua cuplikan muncul di menu cuplikan di Windows PowerShell ISE.