¿Cómo comentar el código de PowerShell? - informaticamadridmayor

Puede comentar el código en un script de PowerShell con fines de documentación o depuración, como en cualquier otro lenguaje de programación. Existen comentarios de línea y bloquear comentarios en PowerShell.

En PowerShell v.1, solo se podían usar comentarios de una sola línea con el carácter # (Hash). Utilice un hashtag seguido de un espacio en blanco (!) Para esto:

# This is a comment in PowerShell. Everything from the first # until the end of the line is treated as a comment.

Insinuación. Esto no es un comentario:

#This is not a PowerShell comment as there is no space after the hash.

El intérprete de PowerShell ignora todo lo que sigue al hashtag (#) en la misma línea al procesar el código.

En las versiones más recientes de PowerShell, puede usar comentarios de varias líneas con el bloque <# #>.

<#

This is

a multiline

comment.

#>

En el siguiente ejemplo, hemos comentado parte del código usando un bloque de comentarios:

$servicename = “Spooler”

if (Get-Service $servicename -ErrorAction SilentlyContinue)

{

Write-Host "$servicename exists"

<#

Get-service $servicename |Restart-Service

Write-host “Service $servicename has been restarted”

#>

}

Los comentarios de varias líneas se usan comúnmente en PowerShell para agregar ayuda descriptiva al comienzo de un archivo de secuencia de comandos PS, pero también se usan para incrustar texto de comentario en un comando.

Puede usar un comentario de bloque para insertar el texto del comentario en un comando de PowerShell:

Get-Content -Path <#specify the path to your file here #> C:pslist.txt

Al editar el código ISE de PowerShell, el código comentado se resalta en verde.

Para agregar un bloque de comentarios en PowerShell ISE, presione CTRL + J y seleccione "Bloque de comentarios" en el menú desplegable. Como resultado, se agregará un bloque de PowerShell con un comentario al panel del editor.

Además, puede seleccionar una línea que desee comentar y presionar el botón Ctrl + K atajo de teclado.

Más convenientemente, puede definir un bloque de comentarios en PowerShell ISE usando la siguiente función:

function Toggle-Comment

{

$file = $psise.CurrentFile

$text = $file.Editor.SelectedText

if ($text.StartsWith("<#")) {

$comment = $text.Substring(3).TrimEnd("#>")

}

else

{

$comment = "<#" + $text + "#>"

}

$file.Editor.InsertText($comment)

}

$psise.CurrentPowerShellTab.AddOnsMenu.Submenus.Add('Toggle Comment', { Toggle-Comment }, 'CTRL+K')

Agregue esta función a su perfil de PowerShell y se importará automáticamente a su sesión cuando se inicie PowerShell ISE. Ahora solo presiona CTRL + K para poner un comentario de bloque para las líneas de código seleccionadas.

Si prefiere usar Código de Visual Studio para editar scripts de PowerShell, puede comentar una o más líneas de código seleccionando las líneas que desee y presionando el atajo de teclado "Ctrl + /" o "Alt + Mayús + A”Para alternar el bloqueo de comentarios.

Es un buen hábito comenzar sus scripts de PowerShell con un bloque de comentarios de descripción como este:

<#

.SYNOPSIS

    Short description

.DESCRIPTION

    Long description

.EXAMPLE

    PS C:> <example usage>

    Explanation of what the example does

.INPUTS

    Inputs (if any)

.OUTPUTS

    Output (if any)

.NOTES

    General notes

#>

En Visual Studio Code, puede agregar automáticamente un bloque de ayuda predeterminado basado en comentarios a su secuencia de comandos escribiendo el comentario-ayuda mando: