Comment commenter du code dans PowerShell ?

Question

Comment commenter le code dans PowerShell (1.0 ou 2.0) ?

Answer 1

Dans PowerShell ISE, vous pouvez frapper Ctrl + J pour ouvrir le Commencer à couper et sélectionner le menu Bloc de commentaires :

Answer 2

Utilisez un hashtag suivi d'un espace blanc ( !) pour cela :

 # Comment here

N'oubliez pas l'espace blanc ici ! Sinon, il peut interférer avec les commandes internes.

Par exemple, c'est no un commentaire :

#requires -runasadmin

Answer 3

Je suis un peu en retard à cette fête, mais il semble que personne n'ait réellement écrit tous les cas d'utilisation. Donc...

La seule version supportée de PowerShell ces jours-ci ( automne 2020 et au-delà ) sont :

• Windows PowerShell 5.1.x
• PowerShell 7.0.x.

Vous ne voulez pas ou ne devriez pas travailler avec différentes versions de PowerShell.

Les deux versions ( ou toute autre version que vous pourriez rencontrer WPS 3.0-5.0, PS Core 6.x.x sur certaines stations dépassées ) partagent la même fonctionnalité de commentaire.

Commentaires d'une ligne

# Get all Windows Service processes <-- one line comment, it starts with '#'
Get-Process -Name *host*

Get-Process -Name *host* ## You could put as many ### as you want, it does not matter

Get-Process -Name *host* # | Stop-Service # Everything from the first # until end of the line is treated as comment

Stop-Service -DisplayName Windows*Update # -WhatIf # You can use it to comment out cmdlet switches

Commentaires multi-lignes

<#
Everyting between '< #' and '# >' is 
treated as a comment. A typical use case is for help, see below.

# You could also have a single line comment inside the multi line comment block.
# Or two... :)

#>

<#
.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
    Some additional notes. This keyword can be used only once in each topic.
    This keyword can be used only once in each topic.

.LINK
    A link used when Get-Help with a switch -OnLine is used.
    This keyword can be used only once in each topic.

.EXAMPLE
    Example 1
    You can use this keyword as many as you want.

.EXAMPLE
    Example 2
    You can use this keyword as many as you want.
#>

Commentaires imbriqués sur plusieurs lignes

<#
Nope, these are not allowed in PowerShell.

<# This will break your first multiline comment block... #>
...and this will throw a syntax error.
#>

Commentaires multilignes imbriqués dans le code

<# 
The multi line comment opening/close
can be also used to comment some nested code
or as an explanation for multi chained operations..
#>
Get-Service | <# Step explanation #>
Where-Object { $_.Status -eq [ServiceProcess.ServiceControllerStatus]::Stopped } | 
<# Format-Table -Property DisplayName, Status -AutoSize |#>
Out-File -FilePath Services.txt -Encoding Unicode

Scénario limite

# Some well written script
exit
Writing something after exit is possible but not recommended.
It isn't a comment.
Especially in Visual Studio Code, these words baffle PSScriptAnalyzer.
You could actively break your session in VS Code.

Answer 4

Vous pouvez le faire :

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

 <#
    for more lines
    ...
    ...
    ...
    ..
    .
 #>

Answer 5

Il existe une façon spéciale d'insérer des commentaires à la fin d'un script :

....
exit 

Hi
Hello
We are comments
And not executed 

Tout ce qui suit exit n'est pas exécuté, et se comportent comme des commentaires.