Udostępnij za pośrednictwem

New-IseSnippet

  • Odwołanie
Moduł:
ISE

Tworzy fragment kodu ŚRODOWISKA Windows PowerShell ISE.

Składnia

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

Opis

Polecenie cmdlet New-ISESnippet tworzy tekst wielokrotnego użytku dla środowiska Windows PowerShell ISE. Możesz użyć fragmentów kodu, aby dodać tekst do okienka Skrypt lub okienka Polecenia w środowisku Windows PowerShell ISE. To polecenie cmdlet jest dostępne tylko w środowisku Windows PowerShell ISE.

Począwszy od programu Windows PowerShell 3.0, środowisko Windows PowerShell ISE zawiera kolekcję wbudowanych fragmentów kodu. Polecenie cmdlet New-ISESnippet umożliwia utworzenie własnych fragmentów kodu w celu dodania do wbudowanej kolekcji. Pliki fragmentów kodu można wyświetlać, zmieniać, dodawać, usuwać i udostępniać oraz dołączać je do modułów programu Windows PowerShell. Aby wyświetlić fragmenty kodu w środowisku Windows PowerShell ISE, z menu Edytuj wybierz pozycję Uruchom fragmenty kodu lub naciśnij CTRL+J.

Polecenie cmdlet new-ISESnippet tworzy Title. Plik Snippets.ps1xml w katalogu $home\Documents\WindowsPowerShell\Snippets z określonym tytułem. Aby dołączyć plik fragmentu kodu do tworzonego modułu, dodaj plik fragmentu kodu do podkatalogu fragmentów kodu w katalogu modułu.

Nie można używać fragmentów kodu utworzonych przez użytkownika w sesji, w której zasady wykonywania są z ograniczeniami lub AllSigned.

To polecenie cmdlet zostało wprowadzone w programie Windows PowerShell 3.0.

Przykłady

Przykład 1. Tworzenie fragmentu kodu Comment-BasedHelp

PS C:\> New-IseSnippet -Title Comment-BasedHelp -Description "A template for comment-based help." -Text "<#
    .SYNOPSIS
    .DESCRIPTION
    .PARAMETER  <Parameter-Name>
    .INPUTS
    .OUTPUTS
    .EXAMPLE
    .LINK
#>"

To polecenie tworzy fragment kodu Comment-BasedHelp dla środowiska Windows PowerShell ISE. Tworzy plik o nazwie "Comment-BasedHelp.snippets.ps1xml" w katalogu fragmentów kodu użytkownika ($home\Documents\WindowsPowerShell\Snippets).

Przykład 2. Tworzenie obowiązkowego fragmentu kodu

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

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

W tym przykładzie tworzony jest obowiązkowy fragment kodu dla środowiska Windows PowerShell ISE. Pierwsze polecenie zapisuje tekst fragmentu kodu w zmiennej $M. Drugie polecenie używa polecenia cmdlet New-ISESnippet w celu utworzenia fragmentu kodu. Polecenie używa parametru Force, aby zastąpić poprzedni fragment kodu o tej samej nazwie.

Przykład 3. Kopiowanie obowiązkowego fragmentu kodu z folderu do folderu docelowego

PS C:\> Copy-Item "$Home\Documents\WindowsPowerShell\Snippets\Mandatory.Snippets.ps1xml" -Destination "\\Server\Share"

To polecenie używa polecenia cmdlet Copy-Item do skopiowania obowiązkowego fragmentu kodu z folderu, w którym New-ISESnippet umieszcza go w udziale plików Server\Share.

Ponieważ pliki Snippets.ps1xml, które New-ISESnippet tworzone są plikami tekstowymi (XML), możesz użyć poleceń cmdlet Item, aby uzyskać, zmienić, przenieść, zmienić nazwę i skopiować je.

Parametry

-Author

Określa autora fragmentu kodu. Pole autora jest wyświetlane w pliku fragmentu kodu, ale nie jest wyświetlane po kliknięciu nazwy fragmentu kodu w środowisku Windows PowerShell ISE.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-CaretOffset

Określa znak tekstu fragmentu kodu, na który to polecenie cmdlet umieszcza kursor. Wprowadź liczbę całkowitą reprezentującą położenie kursora z wartością "1" reprezentującą pierwszy znak tekstu. Wartość domyślna 0 (zero) umieszcza kursor bezpośrednio przed pierwszym znakiem tekstu. Ten parametr nie wcięcie tekstu fragmentu kodu.

Typ:Int32
Position:Named
Domyślna wartość:0
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Description

Określa opis fragmentu kodu. Wartość opisu jest wyświetlana po kliknięciu nazwy fragmentu kodu w środowisku Windows PowerShell ISE. Ten parametr jest wymagany.

Typ:String
Position:2
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Force

Wskazuje, że to polecenie cmdlet zastępuje pliki fragmentu kodu o tej samej nazwie w tej samej lokalizacji. Domyślnie new-ISESnippet nie zastępuje plików.

Typ:SwitchParameter
Position:Named
Domyślna wartość:False
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Text

Określa wartość tekstową dodaną podczas wybierania fragmentu kodu. Tekst fragmentu kodu jest wyświetlany po kliknięciu nazwy fragmentu kodu w środowisku Windows PowerShell ISE. Ten parametr jest wymagany.

Typ:String
Position:3
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Title

Określa tytuł lub nazwę fragmentu kodu. Tytuł nazywa również plik fragmentu kodu. Ten parametr jest wymagany.

Typ:String
Position:1
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

None

To polecenie cmdlet nie pobiera danych wejściowych z potoku.

Dane wyjściowe

None

To polecenie cmdlet nie generuje żadnych danych wyjściowych.

Uwagi

  • New-IseSnippet przechowuje nowe fragmenty kodu utworzone przez użytkownika w niepodpisanych plikach ps1xml. W związku z tym program Windows PowerShell nie może dodać ich do sesji, w której zasady wykonywania są AllSigned lub z ograniczeniami. W sesji z ograniczeniami lub AllSigned można tworzyć, pobierać i importować niepodpisane fragmenty kodu utworzone przez użytkownika, ale nie można ich używać w sesji.

Jeśli używasz polecenia cmdlet New-IseSnippet w z ograniczeniami lub AllSigned sesji, zostanie utworzony fragment kodu, ale podczas próby dodania nowo utworzonego fragmentu kodu do sesji w programie Windows PowerShell zostanie wyświetlony komunikat o błędzie. Aby użyć nowego fragmentu kodu (i innych niepodpisanych fragmentów kodu utworzonych przez użytkownika), zmień zasady wykonywania, a następnie uruchom ponownie środowisko Windows PowerShell ISE.

Aby uzyskać więcej informacji na temat zasad wykonywania programu Windows PowerShell, zobacz about_Execution_Policies.

  • Aby zmienić fragment kodu, edytuj plik fragmentu kodu. Pliki fragmentu kodu można edytować w okienku Skrypt środowiska Windows PowerShell ISE.

  • Aby usunąć dodany fragment kodu, usuń plik fragmentu kodu.

  • Nie można usunąć wbudowanego fragmentu kodu, ale możesz ukryć wszystkie wbudowane fragmenty kodu przy użyciu "$psise. Options.ShowDefaultSnippets=$false" polecenie.

  • Możesz utworzyć fragment kodu o takiej samej nazwie jak wbudowany fragment kodu. Oba fragmenty kodu są wyświetlane w menu fragmentów kodu w środowisku Windows PowerShell ISE.