Comment avez-vous commenter le code en PowerShell?

Comment avez-vous commenter le code en PowerShell (1.0 ou 2.0)?

Remarque '#' est un commentaire dans beaucoup de shell et des langages de script: bash, python, php, ruby, et maintenant powershell.
C'est exactement pourquoi j'ai supposé que # n'est pas un commentaire dans un Windows ou Microsoft basé sur un langage de script.
C'est parce que, apparemment, à la différence de tous les autres technologies, MS n'a pas donné de powershell un décent de référence. Je ne pouvais pas le trouver n'importe où.
PowerShell est un des plus complets de références de n'importe quelle langue. Pour une fonctionnalité à ajouter à la langue, il doit inclure un ensemble complet de help de la documentation avec des exemples, la méthode et les listes de membres, etc.

InformationsquelleAutor labyrinth | 2011-09-08

1183

Dans PowerShell V1 il n'y a qu' # pour rendre le texte à la suite d'un commentaire.
```
# This is a comment in Powershell
```
Dans PowerShell V2 <# #> peut être utilisé pour bloquer les commentaires et plus spécifiquement pour aider les commentaires.
```
#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 et .* voir about_Comment_Based_Help.

Remarque: Ces observations sont utilisées par le Get-Help Applet de commande et peut être mis devant le mot-clé Function, ou à l'intérieur de la {} avant ou après le code lui-même.
- ne savent pas à propos de la <# #> bloc de commentaire. nice
- Vous pouvez trouver la grammaire pour PowerShell v3 ici: microsoft.com/en-us/download/details.aspx?id=36389. Regarder la section B.1.2 Comments.
- J'ai été en utilisant l'Envoyer-MailMessage fonction, avec des backticks de mettre chaque paremeter sur une nouvelle ligne, et commenté l'un d'eux ( -Bcc ) et il a provoqué une erreur sur la ligne suivante ( -Corps : Le terme de "Corps" n'est pas reconnu comme nom d'applet de commande ...) il semble Donc commenter une ligne au milieu d'un appel à une fonction n'est pas prise en charge. C'est peut-être la suite de la ligne, c'est peut-être quelque chose d'autre, de toute façon ce n'est pas la façon dont je m'attends à ce qu'il fonctionne
- Commentant comme cela serait fait en ligne. Votre commande devrait être analysée comme: Envoyez-MailMessage À [email protected] #Ceci est un commentaire -Sujet "Aide-Moi!" etc.
- Je l'ai trouvé plus fiable pour placer la fonction de commentaire dans l'immédiat suite à l'ouverture { (à l'intérieur la fonction). En particulier, j'avais du mal à le faire fonctionner à l'extérieur avec un script fonctions du module.
InformationsquelleAutor JPBlanc
95

Vous utilisez la marque de hachage comme ce
```
# This is a comment in Powershell
```
Wikipedia a une bonne page pour garder une trace de la façon de faire des commentaires en plusieurs langues populaires

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

InformationsquelleAutor adamleerich
38

C'est le #.

Voir PowerShell - Des Caractères Spéciaux Et Des Jetons pour les caractères spéciaux.

InformationsquelleAutor falcojr
30

Seule ligne, les commentaires commencent par un symbole dièse, tout à droite de la # sera ignorée:
```
# Comment Here
```
Dans PowerShell 2.0 et au-dessus de multi-ligne de bloquer les commentaires peuvent être utilisées:
```
<# 
  Multi 
  Line 
#> 
```
Vous pouvez utiliser le bloc de commentaires pour intégrer commentaire de texte à l'intérieur d'une commande:
```
Get-Content -Path <# configuration file #> C:\config.ini
```
Remarque: Parce que PowerShell prend en charge La Saisie Semi-Automatique vous devez être prudent sur la copie et le collage Space + TAB avant les commentaires.
- +1 pour montrer le bloc de commentaires du style utiliser au sein d'une seule ligne. Je suis venu ici à la recherche de comment commenter temporairement éléments individuels d'un tableau déclaré sur une seule ligne.
InformationsquelleAutor Alexander

Ici

# Single line comment in Powershell

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

Ce que cela ajoute à l'existant réponses?
Juste garder les choses simples & direct

InformationsquelleAutor Vic

13

Dans PowerShell ISE, vous pouvez appuyer sur Ctrl+J pour ouvrir le Démarrer la Capture menu et sélectionnez bloc de Commentaire:
- Cela permet d'insérer un nouveau bloc de commentaire; il n'a pas à commenter les lignes existantes.
InformationsquelleAutor Martin Brandl

Vous pouvez faire:

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

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

InformationsquelleAutor Mister X CT

Vous devez vous connecter pour publier un commentaire.