1001 votes

Comment commenter du code dans PowerShell ?

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

27 votes

Note '#' est un commentaire dans beaucoup de langages shell et script : bash, python, php, ruby, et maintenant powershell.

66 votes

C'est exactement pourquoi j'ai supposé que # n'est pas un commentaire dans un langage de script basé sur Windows ou Microsoft.

2 votes

C'est parce que, apparemment, contrairement à toutes leurs autres technologies, MS n'a pas donné à powershell une référence décente. Je ne l'ai trouvé nulle part.

1338voto

JPBlanc Points 26156

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.

52 votes

Je ne connaissais pas le commentaire du bloc <# #>. sympa

3 votes

Vous pouvez trouver la grammaire pour PowerShell v3 ici : microsoft.com/fr/download/details.aspx?id=36389 . Regardez la section B.1.2 Comments .

0 votes

J'utilisais la fonction Send-MailMessage, avec des backticks pour mettre chaque paramètre sur une nouvelle ligne, et j'ai commenté l'un d'entre eux ( -Bcc ) et cela a provoqué une erreur sur la ligne suivante ( -Body : The term '-Body' is not recognized as the name of a cmdlet ...) Il semble donc que commenter une ligne au milieu d'un appel à une fonction ne soit pas supporté. Peut-être que c'est la continuation de la ligne, peut-être que c'est autre chose, mais dans tous les cas, ce n'est pas comme ça que je m'attendais à ce que ça fonctionne.

104voto

adamleerich Points 1722

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

44voto

Alexander Points 1624

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.

4 votes

+1 pour avoir montré l'utilisation du style de commentaire en bloc sur une seule ligne . Je suis venu ici pour chercher comment commenter temporairement les éléments individuels d'un tableau déclaré sur une seule ligne.

37voto

falcojr Points 365

C'est le # .

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

20voto

Vic Points 82

Ici

# Single line comment in Powershell

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

12 votes

Qu'est-ce que cela ajoute aux réponses existantes ?

6 votes

Je reste simple et direct

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X