it-swarm.com.de

Wie kommentieren Sie Code in PowerShell aus?

Wie kommentieren Sie Code in PowerShell (1.0 oder 2.0) aus?

900
labyrinth

In PowerShell V1 gibt es nur #, um den Text danach zu kommentieren.

# This is a comment in Powershell

In PowerShell V2 kann <# #> für Blockkommentare und insbesondere für Hilfekommentare verwendet werden.

#REQUIRES -Version 2.0

<#
.SYNOPSIS
    A brief description of the function or script. This keyword can be used
    only once in each topic.
.DESCRIPTION
    A detailed description of the function or script. This keyword can be
    used only once in each topic.
.NOTES
    File Name      : xxxx.ps1
    Author         : J.P. Blanc ([email protected])
    Prerequisite   : PowerShell V2 over Vista and upper.
    Copyright 2011 - Jean Paul Blanc/Silogix
.LINK
    Script posted over:
    http://silogix.fr
.EXAMPLE
    Example 1
.EXAMPLE
    Example 2
#>
Function blabla
{}

Weitere Erläuterungen zu .SYNOPSIS und .* finden Sie unter about_Comment_Based_Help .

Anmerkung: Diese Funktionskommentare werden vom Befehl Get-Help verwendet und können vor dem Schlüsselwort Function oder innerhalb des Befehls {} vor oder nach dem Code selbst eingefügt werden.

1198
JPBlanc

Sie verwenden das Hash-Zeichen wie folgt

# This is a comment in Powershell

Wikipedia bietet eine gute Seite, um Kommentare in mehreren gängigen Sprachen zu verfassen

http://en.wikipedia.org/wiki/Comparison_of_programming_languages_ (syntax) #Comments

96
adamleerich

Es ist der #.

Siehe PowerShell - Sonderzeichen und Token für Sonderzeichen.

38
falcojr

Einzeilige Kommentare beginnen mit einem Hash-Symbol , alles rechts vom # wird ignoriert:

# Comment Here

In PowerShell 2.0 und höher können mehrzeilige Blockkommentare verwendet werden:

<# 
  Multi 
  Line 
#> 

Sie können Blockkommentare verwenden, um Kommentartext in einen Befehl einzubetten:

Get-Content -Path <# configuration file #> C:\config.ini

Hinweis: Da PowerShell Tab Completion unterstützt, müssen Sie beim Kopieren und Einfügen von Space + TAB vor Kommentaren vorsichtig sein.

32
Alexander

Hier

# Single line comment in Powershell

<# 
--------------------------------------
Multi-line comment in PowerShell V2+ 
-------------------------------------- 
#>
16
Vic

In PowerShell ISE können Sie drücken Ctrl+J Öffnen Sie das Menü Start Snipping und wählen Sie Kommentarblock :

enter image description here

13
Martin Brandl

Du kannst das schaffen:

 (Some basic code) # Use "#" after a line and use:

 <#
    for more lines
    ...
    ...
    ...
    ..
    .
 #>
3
Mister X CT