Colocación de la Ayuda basada en comentarios en las funciones

En este tema se explica dónde colocar la ayuda basada en comentarios de una función para que el cmdlet Get-Help asocie el tema de ayuda basado en comentarios con la función correcta.

Dónde colocar Comment-Based Ayuda para una función

• Al principio del cuerpo de la función.

• Al final del cuerpo de la función.

• Antes de la palabra clave Function. Cuando la función está en un script o módulo de script, no puede haber más de una línea en blanco entre la última línea de la ayuda basada en comentarios y la palabra clave Function. De lo contrario, Get-Help asocia la ayuda con el script, no con la función .

Ejemplos de ubicación de ayuda en una función

En los ejemplos siguientes se muestra cada una de las tres opciones de selección de ubicación de la ayuda basada en comentarios para una función.

Ayuda al principio de un cuerpo de función

En el ejemplo siguiente se muestra el comentario basado en comentarios al principio de un cuerpo de función.

function MyProcess
{
    <#
       .DESCRIPTION
       The MyProcess function gets the Windows PowerShell process.
    #>

    Get-Process powershell
}

Ayuda al final de un cuerpo de función

En el ejemplo siguiente se muestra el comentario basado en comentarios al final de un cuerpo de función.

function MyFunction
{
    Get-Process powershell

    <#
       .DESCRIPTION
       The MyProcess function gets the Windows PowerShell process.
    #>
}

Ayuda antes de la palabra clave function

En los ejemplos siguientes se muestra el comentario basado en la línea antes de la palabra clave function.

<#
    .DESCRIPTION
    The MyProcess function gets the Windows PowerShell process.
#>
function MyFunction { Get-Process powershell}