Búsqueda de sitios web

Comentario de PowerShell | Vistazo rápido al comentario de PowerShell

Introducción al comentario de PowerShell

El comentario de PowerShell es un tipo de ayuda para brindar detalles breves básicos del código. Puede agregar un comentario a cualquier sección del script de PowerShell, como un comentario que puede proporcionar para la función o un comentario que puede proporcionar para las condiciones, bucles, etc. El scripter que lee el código comprenderá fácilmente de qué se trata el código. . También podemos utilizar los comentarios para proporcionar las secciones de ayuda. El comentario no se mostrará cuando se ejecute el script; es sólo para la información del usuario.

Tipos de comentarios de PowerShell

Hay dos tipos de comentarios de PowerShell que podemos usar:

  • Comentario de una sola línea: También se denomina comentario en línea y solo puede comentar una línea.
  • Comentario de varias líneas: Esto también se denomina comentario de bloque y se aplica a unas pocas líneas de código o a todo el código.

Sintaxis:

Los comentarios de una sola línea o los comentarios en línea se pueden describir con la sintaxis Hash (#), mientras que los comentarios de varias líneas o los comentarios de bloque se pueden describir con etiquetas y Hash como <#..#>

Ejemplos

A continuación se muestran ejemplos de comentarios de PowerShell:

Ejemplo #1

Comentario de una sola línea para describir el código.

Código:

Rename-Item C:\Temp\azgroup.json -NewName azuregroup.json  # This command will rename the item

Ejemplo #2

Comentario único para describir la función.

Código:

function GetData{
#Function will get the data from azure blob
}

Ejemplo #3

Comente para deshabilitar el código específico.

Código:

# Copy-Item C:\Temp\NewUsers.csv -Destination \\test1-win2k12\c$\temp

Cuando comentas cualquier código, puedes notar que el color de la línea cambia. Depende del editor y del tema que hayas aplicado para ese editor. Si tiene el bloque que describe las múltiples líneas juntas como "bucle", "función", "for loop", etc., y si aplica un comentario para una sola línea, eso podría generar un error.

Código:

while($i -gt 10){
Write-Output $i
$i++
}

Si desactiva la primera línea usando un comentario en el ejemplo anterior, generará un error.

Código:

# while($i -gt 10){
Write-Output $i
$i++
}

Salida:

El error dice que no se espera el '}' adicional porque ya hemos desactivado el '{'. Puede utilizar el comentario de una sola línea para deshabilitar las múltiples líneas de código.

Código:

# while($i -gt 10){
#  Write-Output $i
#  $i++
#}

Pero no se recomienda este método; en su lugar, podemos usar el comentario de varias líneas para desactivarlos, como se muestra en los ejemplos siguientes.

Ejemplo #4

Comentario de varias líneas para describir el guión.

Código:

<#
This program is to test the server connectivity.
Once connectivity establishes it checks the WINRM connection on the server.
The third step is to push the Application agent on the servers
In the final step, server will be rebooted
#>

En el ejemplo anterior, hemos creado un bloque de comentarios de varias líneas usando PowerShell y no se ejecutará. Se utiliza cuando desea colocar detalles específicos sobre los parámetros, por ejemplo, formato de fecha, o el usuario debe tener en cuenta antes de ejecutar el script, como la ruta de salida de los registros.

Ejemplo #5

Comentario de varias líneas para deshabilitar la función o parte del código.

Como se muestra en el ejemplo 'c', podemos desactivar todo el ciclo while usando comentarios de una sola línea, pero sería mucho más fácil usar comentarios de varias líneas.

Código:

<#while($i -gt 10){
Write-Output $i
$i++
}#>

Es mucho más fácil que el comentario de una sola línea.

Ayuda basada en comentarios de PowerShell

Este también es un tipo de comentario de varias líneas. La ayuda basada en comentarios de PowerShell funciona con palabras clave. Cada palabra clave describe los temas específicos para su uso previsto y se pueden utilizar dentro de la sección de comentarios de varias líneas.

Estas palabras clave pueden aparecer en cualquier orden, no distinguen entre mayúsculas y minúsculas y comienzan con un punto (.). No es necesario mencionar todas las palabras clave. Puede agregar algunos de ellos según sus necesidades.

  • .SYNOPSIS: Una breve descripción de la función o el script. Esta palabra clave se utiliza sólo una vez.
  • .DESCRIPCIÓN: Una descripción detallada del guión. Esta palabra clave se utiliza sólo una vez.
  • .EJEMPLO: Un ejemplo de muestra para el script junto con entrada y salida. Podemos agregar múltiples ejemplos.
  • .PARAMETER : Descripción del parámetro. Esta palabra clave se puede utilizar para cada parámetro del script. Puede estar en cualquier orden, pero el orden en que se mencionan en el bloque Param() aparecerá en la sección de ayuda.
  • .INPUTS: Descripción de los objetos de entrada o los tipos de objetos que se pueden canalizar al script o función.
  • .OUTPUTS: Descripción del objeto devuelto o los tipos de objetos que devuelve el cmdlet.

Las anteriores son las palabras clave básicas que generalmente necesitamos para describir la sección de ayuda basada en comentarios de la función. Aparte de eso, hay otras palabras clave que también puedes especificar, como NOTAS, ENLACE, COMPONENTE, ROL, FUNCIONALIDAD, etc.

Ejemplo:

Código:

function TestRemotePort{
param(
[String]$ComputerName,
[Int]$Port
)
<#
.SYNOPSIS
Function to test remote ports.
.DESCRIPTION
This script checks port on the remote computers
.EXAMPLE
TestRemotePort -ComputerName ServerName -Port 8080
.PARAMETER ComputerName
Remote Server Name
.PARAMETER Port
Remote port number
.INPUTS
ComputerNames can be passed and a port can be passed
.OUTPUTS
True or False
#>
Test-NetConnection -ComputerName $ComputerName -Port $Port
}

Salida:

También puede colocar la ayuda basada en comentarios al principio del script.

Código:

<#
.DESCRIPTION
This script will test the connection with the remote server
#>
param(
[Parameter(Mandatory=$true)]
[String]$Server
)
Test-Connection -ComputerName $Server -Count 2 -quiet

Salida:

Y la ayuda basada en comentarios se puede colocar al final del guión.

Código:

function TestNetConnection{
Test-Netconnection -ComputerName $computername -Port $port
}
<#
.DESCRIPTION
The above function checks the port on the remote computer.
#>

Artículos relacionados