So erstellen Sie beschreibende PowerShell -Kommentare

PowerShell Scripting unterstützt Kommentare, um Anweisungen für menschlich lesbare Anweisungen hinzuzufügen. Insbesondere werden das Skript zum Debugging- und Dokumentationszwecken Kommentare hinzugefügt. Diese beschreibenden Kommentare helfen anderen Programmierern, den Code klarer zu verstehen. Beschreibende Kommentare können Einzellinien- oder Mehrzeilen-Kommentare sein.

In diesem Artikel werden verschiedene Methoden erörtert, um beschreibende Kommentare zu erstellen.

So erstellen Sie beschreibende PowerShell -Kommentare?

In PowerShell können die deskriptiven Kommentare mit den unten erwähnten Methoden erstellt werden:

• Einzellinien-Beschreibungskommentare.
• Multiline beschreibende Kommentare.

Methode 1: Einzellinienbeschreibungskommentare

Einzelzeilen-Kommentare können erstellt werden, um Codebeschreibungen mit der “hinzuzufügen#" Hashtag. Der neben dem Hashtag geschriebene Text wird als Kommentar betrachtet. Diese Kommentare werden verwendet, um kleinere Codebeschreibungen hinzuzufügen.

Beispiel
In diesem Beispiel wird gezeigt, dass er im PowerShell -Skript einen einzigen Zeilenkommentar hinzufügt:

# Dies ist ein einzelner Zeilenkommentar.
Schreibhost "Deskriptiver Kommentar wird nicht angezeigt."
# Einzelzeilen deskriptiven Kommentars

Nach dem obigen Code:

• Erstellen Sie zunächst einen einzelnen Kommentar mit der “#" Hashtag.
• Danach geben Sie das an “Schreibhost”CMDLET zum Hinzufügen einer String -Linie.
• Fügen Sie schließlich den Einzelzeilen-Kommentar hinzu:

Es kann beobachtet werden, dass der einzeilige beschreibende Kommentar erfolgreich hinzugefügt wurde und nicht in der PowerShell-Konsole angezeigt wurde.

Methode 2: multiline beschreibende Kommentare

Kommentare sehen gut aus, wenn sie kurz und präzise sind, aber es ist die Notwendigkeit, detaillierte beschreibende Kommentare zu schreiben. Diese Kommentare werden als Multiline- oder Kommentarblöcke bezeichnet. Insbesondere beginnen Multiline -Kommentare oder Kommentareblöcke mit diesem Symbol “<#"Und enden damit"#>Symbol. Alles, was in diesen Symbolen geschrieben wurde.

Beispiel
In diesem Beispiel wird die Erstellung der Multiline -Kommentare in PowerShell veranschaulicht:

<# Description
des Code
kann hier hinzugefügt werden
#>
Schreibhost "Dies ist ein Multi-Line-Kommentarbeispiel."

Nach dem obigen Code:

• Fügen Sie zunächst den Multiline -Kommentar innerhalb des Starts hinzu “<#"Und Ende"#>Symbole.
• Danach fügten wir das hinzu “Schreibhost”CMDLET zum Hinzufügen einer String -Zeile:

Der multi-line-beschreibende Kommentar wurde erfolgreich hinzugefügt und wurde in der PowerShell-Konsole nicht angezeigt.

Abschluss

Der deskriptive Kommentars in PowerShell kann mit Einzelzeilen- und Mehrzeilen-Kommentaren erstellt werden. Einzelne Kommentare können erstellt werden, indem der Hashtag hinzufügt#Hashtag zu Beginn der Linie. Während mehrere Linienkommentare in der “erstellt werden“<#"Start und die"#>”Endesymbole. Dieser Blog hat einen detaillierten Leitfaden zum Erstellen beschreibender PowerShell -Kommentare erstellt.