New-IseSnippet

Tworzy fragment kodu Windows PowerShell ISE.

Składnia

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

Opis

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

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

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

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

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

Przykłady

Przykład 1. Tworzenie fragmentu kodu pomocy Comment-Based

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 Windows PowerShell ISE. Tworzy plik o nazwie Comment-BasedHelp.snippets.ps1xml w katalogu $HOME\Documents\WindowsPowerShell\Snippetsfragmentów kodu użytkownika .

Przykład 2. Tworzenie obowiązkowego fragmentu kodu

$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

W tym przykładzie zostanie utworzony fragment kodu o nazwie Obowiązkowy dla Windows PowerShell ISE. Pierwsze polecenie zapisuje tekst fragmentu kodu w zmiennej $M . Drugie polecenie używa polecenia cmdlet do utworzenia New-ISESnippet 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

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

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

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.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters: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 znakiem "1" reprezentującym pierwszy znak tekstu. Wartość domyślna, 0 (zero), umieszcza kursor bezpośrednio przed pierwszym znakiem tekstu. Ten parametr nie wcięcie tekstu fragmentu kodu.

Type:Int32
Position:Named
Default value:0
Accept pipeline input:False
Accept wildcard characters: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.

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

-Force

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

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters: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.

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

-Title

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

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters: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 utworzonego przez użytkownika w niepodpisanych plikach ps1xml. W związku z tym Windows PowerShell nie może dodać ich do sesji, w której zasady wykonywania są AllSigned lub Ograniczone. 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 New-IseSnippet polecenia cmdlet w sesji z ograniczeniami lub AllSigned, zostanie utworzony fragment kodu, ale zostanie wyświetlony komunikat o błędzie, gdy Windows PowerShell spróbuje dodać nowo utworzony fragment kodu do sesji. Aby użyć nowego fragmentu kodu (i innych niepodpisanych fragmentów kodu utworzonego przez użytkownika), zmień zasady wykonywania, a następnie uruchom ponownie Windows PowerShell ISE.

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

  • Aby zmienić fragment kodu, edytuj plik fragmentu kodu. Pliki fragmentów kodu można edytować w okienku Skrypt Windows PowerShell ISE.
  • Aby usunąć dodany fragment kodu, usuń plik fragmentu kodu.
  • Nie można usunąć wbudowanego fragmentu kodu, ale można ukryć wszystkie wbudowane fragmenty kodu przy użyciu elementu "$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 Windows PowerShell ISE.