Jak tworzyć opisowe komentarze PowerShell

PowerShell Scripting obsługuje komentarze w celu dodania instrukcji odczytujących ludzi. Mówiąc dokładniej, komentarze są dodawane do skryptu do celów debugowania i dokumentacji. Te opisowe komentarze pomagają innym programistom lepiej zrozumieć kod. Komentarze opisowe mogą być komentarzami jednoliniowymi lub wieloma.

W tym spisie omówi kilka metod tworzenia opisowych komentarzy.

Jak tworzyć opisowe komentarze PowerShell?

W PowerShell opisowe komentarze można tworzyć przy użyciu poniżej wspomnianych metod:

• Komentarze opisowe jednoliniowe.
• Multiline opisowe komentarze.

Metoda 1: opisowe komentarze jednoliniowe

Komentarze jednokierunkowe można utworzyć, aby dodać opisy kodów za pomocą „#”Hashtag. Tekst napisany obok hashtagu zostanie uznany za komentarz. Te komentarze są używane do dodania drobnych opisów kodu.

Przykład
Ten przykład zostanie pokazany, aby dodać komentarz jednego wiersza w skrypcie PowerShell:

# To jest komentarz w jednym wierszu.
Write-host „Komentarz opisowy nie wyświetla."
# Komentarz opisowy pojedynczy linia

Zgodnie z powyższym kodem:

• Najpierw utwórz komentarz jednoliniowy za pomocą „#”Hashtag.
• Następnie określ „Write-host”CMDLET, aby dodać linię ciągów.
• Na koniec dodaj komentarz jednokierunkowy:

Można zauważyć, że opisowy komentarz jednoliniowy został pomyślnie dodany i nie wyświetlał się w konsoli PowerShell.

Metoda 2: Multiline opisowe komentarze

Komentarze wyglądają dobrze, gdy są krótkie i zwięzłe, ale pojawia się potrzeba napisania szczegółowych opisowych komentarzy. Te komentarze nazywane są blokami wielopoziomowymi lub komentarzami. Mówiąc dokładniej, komentarze wielopoziomowe lub bloki komentarzy zaczynają się od tego symbolu „<#”I kończą się tym„#>”Symbol. Wszystko napisane w tych symbolach będzie uważane za wielozadaniowe komentarze opisowe.

Przykład
Ten przykład ilustruje tworzenie komentarzy multiline w PowerShell:

<# Description
kodu
można dodać tutaj
#>
Write-host „To przykład komentarza wieloletniego."

Zgodnie z powyższym kodem:

• Najpierw dodaj komentarz multiline w ramach początku „<#”I zakończenie„#>„Symbole.
• Następnie dodaliśmy „Write-host”CMDLET, aby dodać linię ciągów:

Komentarz opisowy wieloletnice został pomyślnie dodany i nie wyświetlał się w konsoli PowerShell.

Wniosek

Opisowy komentarz w PowerShell można utworzyć za pomocą komentarzy jednolodowych i wielu linii. Pojedyncze komentarze można stworzyć, dodając hashtag „#- Hashtag na początku linii. Podczas gdy komentarze do wielu linii są tworzone w „<#”Początek i„#>„Zakończone symbole. Ten blog opracował szczegółowy przewodnik po tworzeniu opisowych komentarzy PowerShell.