Comentario multilínea de PowerShell | Guía para comentarios multilínea de PowerShell

Introducción al comentario multilínea de PowerShell

PowerShell El comentario de varias líneas es la forma de agregar la descripción del script, función o escribir la ayuda para describir la funcionalidad para obtener una mejor comprensión y explicación del script o la parte del script sin ejecutar esa parte y además, es Es útil escribir la ayuda basada en comentarios sobre la función agregando la sintaxis, parámetros, ejemplos, etc.

Sintaxis:

Los comentarios de varias líneas se describen dentro del bloque <#…#>

Ayuda basada en comentarios.

<#
.<help keyword>
<help content>
#>

¿Cómo funcionan los comentarios de varias líneas en PowerShell?

Para agregar el comentario de una sola línea, usamos el # delante de la línea y en PowerShell 2.0 o una versión anterior esta era la única forma de agregar comentarios de varias líneas. Esto significa que si tiene la descripción de las 10 líneas, deberá colocar 10 veces "#" delante de la línea.

Los comentarios de una sola línea ‘#’ todavía están ahí para describir una pequeña parte de la función o el script. Vea cómo se ven los siguientes comentarios de una sola línea.

# This part won't be executed

Salida:

Incluso las expresiones o cualquier sintaxis no se ejecutarán dentro de este bloque.

# Get-Date

Salida:

Siempre que PowerShell encuentra las palabras clave # o cualquier contenido entre las palabras clave <#…#>, omite esa parte para la ejecución.

Ahora digamos que tenemos un guión y necesitamos describir algo sobre él. Si utilizamos comentarios de una sola línea, ¿puedes asumir lo ridículo que parece escribir cada vez que # informa de la línea?

Así es como necesitamos poner el signo # en cada línea agregando simplemente los comentarios multilínea <#…#> en el script, podemos evitar #< firma cada vez.

Algunas cosas a tener en cuenta:

• No puede formatear las fuentes de los comentarios ingresados dentro del bloque. Intente poner las fuentes en negrita, cambie el color de la fuente, no funcionará porque es el formato único para cada editor. La visualización del color del bloque de comentarios depende del editor que estemos usando y del tema que hayas seleccionado.

Los comentarios de varias líneas o de una sola línea pueden verse diferentes en el código de PowerShell ISE y Visual Studio. A continuación se muestran los comentarios de varias líneas del código PowerShell ISE y VS.

<# Este comentario es de PowerShell ISE

El color de fuente es diferente al del código VS

#>

Del código VS con el tema Atom.

<# This comment is from the VS code
Font color is different than PowerShell ISE
#>

• No puede pasar ningún valor de variable dentro del bloque de comentarios de varias líneas. Por ejemplo,

$name = "PowerShell"
<#
This $name variable won't expand because
This is a multiline comment
#&gt

La salida no puede expandir el nombre.

Ejemplos

Analicemos ejemplos de comentarios multilínea de PowerShell.

Ejemplo n.º 1: agregar un comentario de varias líneas para describir el script

Cuando escribe un script, puede describir la información del script, como la versión y la funcionalidad, con los comentarios de varias líneas como se muestra a continuación y puede usarlo tantas veces como desee porque no hay límite para ello.

Aquí hay una combinación de comentarios de una sola línea y de varias líneas.

<#
Script Version: 1.0
Script Author: Chirag Nagrekar
Repo Location: Company Git Location
#>
function StopServices{
<#
Using foreach loop for the script
Getting the name of the servers to stop the Spooler service
#>
foreach($server in $servers){
Stop-Service -Name Spooler -Force -Verbose
}
}
#Calling StopServices Function
StopServices

Ejemplo n.º 2: acceso directo para agregar comentarios de varias líneas

En el código de Visual Studio, hay un atajo para agregar comentarios multilínea seleccionando las líneas que necesitamos comentar y luego presionando el botón ALT + SHIFT + A.

Por ejemplo,

This is the first line
This is the second line
This is the third line

Necesitamos comentar las líneas anteriores. Primero, seleccione esas líneas y presione ALT + SHIFT + A.

Salida:

Ejemplo #3: Agregar comentarios de varias líneas para la descripción de la ayuda

Los comentarios de varias líneas también son útiles para escribir ayuda basada en comentarios, como se muestra a continuación. Son específicos y se describen con el .HelpName.

function CheckConnectivity{
param(
[String]$computername,
[String]$Timeout
)
<#
.SYNOPSIS
This function retries the computer connectivity for the specific time.
.PARAMETER ComputerName
Remote Computer Name
.PARAMETER Timeout
Specify the timeout in seconds
.EXAMPLE
PS> CheckConnectitivy -ComputerName TestComp -Timeout 120
#>
}

Cuando consulta la ayuda relacionada con esta función, la ayuda anterior basada en comentarios es útil para describir la función.

Para saber más sobre esta sección, utilice el siguiente enlace.

microsoft.powershell.core

Conclusión

No solo PowerShell sino casi todos los demás lenguajes de programación de alto nivel también usan comentarios de una o varias líneas, de modo que cuando escribimos un script, no necesitamos imprimir todo en la consola de salida, sino que necesitamos que los usuarios o programadores comprendan cuál es el script en particular. es para, puedes mencionar la versión del script. Además, puede agregar ayuda relacionada con los scripts.