Come commentare il codice in PowerShell

Se hai utilizzato altre lingue come Bash, Python e Ruby, il commentare in Windows PowerShell sarà simile.

Questo articolo discuterà tutti i casi d’uso che possiamo utilizzare per commentare il codice in Windows PowerShell.

Commenti One-Line di PowerShell Usando il Simbolo di Commento (#)

Sin dall’inizio, PowerShell V1.0 è stato spedito e rilasciato al pubblico con la capacità di commentare il codice. Utilizziamo il simbolo (#) per commentare il codice. Chiamiamo questo simbolo in molti modi come il segno numero o l’hash, ma Microsoft lo chiama ufficialmente simbolo di commento.

Un singolo simbolo di commento (#) commenterà il codice dalla prima # fino alla fine della linea. Ovviamente, puoi anche mettere più simboli di commento in una riga.

Codice Esempio:

#######################################################
# Examples of one-line comments in Windows PowerShell #
#######################################################

Get-Process -Name *host* #### You could put more.

Get-Process -Name *host* # | Stop-Service # You can use it to comment out a part of a line.

# Get-Process -Name *host* # This will comment out the whole line.

Quando si commenta il codice, è buona pratica lasciare uno spazio tra il simbolo di commento e il tuo codice. Alcuni cmdlet utilizzano il simbolo di commento ma non per commentare il codice. Ad esempio, il cmdlet #REQUIRES è un’affermazione PowerShell ben nota che impedirà l’esecuzione di uno script a meno che i moduli o gli snap-in indispensabili non siano soddisfatti.

Codice Esempio:

Get-Module AzureRM.Netcore | Remove-Module
#REQUIRES -Modules AzureRM.Netcore

Utilizzando queste buone pratiche, possiamo evitare errori inutili nel nostro script.

Commentare Più Linee di PowerShell Usando i Blocchi di Commento

Per commentare più linee di codice senza utilizzare più simboli di commento per riga, possiamo convenientemente racchiudere il nostro simbolo di commento tra i segni minore (<) e maggiore (>). Chiamiamo questo un blocco di commento.

Il simbolo di commento con il segno minore (<#) agirà come un tag di apertura per il nostro blocco di commento, mentre il simbolo di commento con il segno maggiore servirà come un tag di chiusura (#>).

Codice Esempio:

<#
Get-Process -Name *host*
Stop-Service -DisplayName Windows*Update -WhatIf
#>

Vale la pena notare che puoi inserire un singolo simbolo di commento tra il blocco di commento.

Codice Esempio:

<#
Get-Process -Name 'host1'

#Tested up until this point

Stop-Service -DisplayName Windows*Update -WhatIf
#>

Tuttavia, annidare blocchi di commento inserendo un nuovo set di tag di blocco di commento risulterà in un errore.

Codice Esempio:

<#
Nope, these are not allowed in PowerShell.

<# This will break your first multiline comment block... #>

...and this will throw a syntax error. #This line will execute the throw cmdlet
#>

In alternativa, premere Ctrl+J e fare clic su Comment Block genererà un blocco di codice nel tuo script.

Scenario Edge Case di PowerShell Usando il Comando Exit

Ricorda che il comando Exit terminerà e chiuderà il tuo ambiente di scripting. Quindi, qualsiasi cosa scritta dopo il comando Exit non viene eseguita. Chiamiamo questo lo scenario edge case. Scrivere qualcosa dopo il comando Exit è possibile ma non consigliato perché altri ambienti di scripting potrebbero interpretare erroneamente queste righe extra e causare un errore.

Codice Esempio:

Get-Process -Name 'host1'
exit

Anything beyond the `<# exit #>` line is not executed inside the PowerShell scripting environment. However, as mentioned before, this is not recommended despite being possible.