¿Cómo comentar el código en PowerShell?

syntax powershell-v2.0

Question

¿Cómo comentar el código en PowerShell (1.0 o 2.0)?

Answer 1

En PowerShell ISE, puede presionar Ctrl + J para abrir el menú Comenzar a cortar y seleccionar el bloque Comentario :

Answer 2

En PowerShell V1 solo hay # para hacer que el texto sea un comentario.

# This is a comment in Powershell

En PowerShell V2 <# #> puede usarse para comentarios de bloque y más específicamente para comentarios de ayuda.

#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 ([email protected])
    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
{}

Para obtener más información sobre .SYNOPSIS y .* Consulte about_Comment_Based_Help .

Observación: Get-Help CmdLet utiliza estos comentarios de función y puede colocarlos antes de la Function palabra clave, o dentro de {} antes o después del código.

Answer 3

Es el # .

Consulte PowerShell - Caracteres especiales y tokens para caracteres especiales.

Answer 4

Los comentarios de una sola línea comienzan con un símbolo de hash , todo lo que está a la derecha del # se ignorará:

# Comment Here

En PowerShell 2.0 y superior, se pueden usar comentarios de bloque de varias líneas:

<# 
  Multi 
  Line 
#> 

Podría usar comentarios de bloque para incrustar texto de comentario dentro de un comando:

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

Nota: Debido a que PowerShell admite la finalización de pestañas , debe tener cuidado al copiar y pegar Space + TAB antes de los comentarios.

Answer 5

Puedes hacer:

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

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

Answer 6

Usas la marca como esta

# This is a comment in Powershell

Wikipedia tiene una buena página para hacer un seguimiento de cómo hacer comentarios en varios idiomas populares

http://en.wikipedia.org/wiki/Comparison_of_programming_languages_(syntax)#Comments

Answer 7

aquí

# Single line comment in Powershell

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