Comentarios

Al igual que en muchos lenguajes de programación, Powershell permite el uso de comentarios.

Los comentarios son esecnciales para documentar scripts, describir funciones y facilitar la comprensión del código, tanto para el propio autor como para otros usuarios. Powershell ofrece dos formas principales de agregar comentarios.

Comentarios en linea

La primera de las formas, es utilizando los llamados comentarios en linea, los cuales se utilizan para agregar una breve descripción o explicación en una sola linea.

Para agregar un comentario de este estilo, se utiliza el carácter # (hash).

Por ejemplo:

# Es es un comentario de una sola línea
Echo "Hello World!"

Comentarios en bloque

La segunda forma es utilizando comentarios de varias lineas o llamados también comentarios de bloque. Este estilo de comentarios, se emplena para describir explicaciones extensas o documentar bloques de código.

Por ejemplo:

<#
Este es un comentario en bloque
o también llamado comentario de varias
lineas.
Podemos utilizarlo para describir scripts describir explicaciones extensas o documentar bloques de código.
#>
Echo "Hello World!"

Comentarios en funciones

Por ultimo, podemos agregar otro tipo de comentarios que es muy util para documentar nuestras funciones o scripts en Powershell.

Por ejemplo:

<#
.SYNOPSIS
    Describe brevemente qué hace la función.
.DESCRIPTION
    Explica más a fondo el propósito y cómo funciona.
.PARAMETER name
    Describe el parámetro 'name'.
.EXAMPLE
    Describe un ejemplo de uso:
    Get-Greet -name"Dean"
#>
function Get-Greet {
    param (
        [string]$name
    )
    Echo "Hello, $name"
}

Referencias

• about_Comment_Based_Help