Comment commenter du code dans PowerShell ?

Question

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

Answer 1

Dans PowerShell V1 il y a seulement # pour que le texte qui suit soit un commentaire.

# This is a comment in Powershell

Dans PowerShell V2 <# #> peut être utilisé pour les commentaires de bloc et plus particulièrement pour les commentaires d'aide.

#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 (jean-paul_blanc@silogix-fr.com)
    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
{}

Pour plus d'explications sur .SYNOPSIS y .* voir about_Comment_Based_Help .

Remarque : Ces commentaires de fonction sont utilisés par le Get-Help CmdLet et peut être placé avant le mot-clé Function ou à l'intérieur du {} avant ou après le code lui-même.

Answer 2

Vous utilisez le dièse comme ceci

# This is a comment in Powershell

Wikipedia a une bonne page pour savoir comment faire des commentaires dans plusieurs langues populaires.

http://en.wikipedia.org/wiki/Comparison_of_programming_languages_(syntaxe)#Commentaires

Answer 3

Les commentaires d'une seule ligne commencent par un symbole dièse tout ce qui se trouve à droite de la # seront ignorés :

# Comment Here

Dans PowerShell 2.0 et plus, il est possible d'utiliser des commentaires de blocs de plusieurs lignes :

<# 
  Multi 
  Line 
#> 

Vous pouvez utiliser les commentaires en bloc pour intégrer le texte du commentaire dans une commande :

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

Note : Parce que PowerShell supporte Complément d'onglet vous devez être prudent en copiant et collant Space + TAB avant les commentaires.

Answer 4

C'est le # .

Voir PowerShell - Caractères spéciaux et jetons pour les caractères spéciaux.

Answer 5

Ici

# Single line comment in Powershell

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