Parameter Comments and Get-Help about powershellpracticeandstyle HOT 2 CLOSED

No, it is a valid location for parameter help in the comment based help scheme.

This example shows it in action:

function MyFunction {
    <#
    .SYNOPSIS
        The synopsis
   
    .DESCRIPTION
        The description
    #>
    [CmdletBinding()]
    param (
        <#
            Parameter help content
        #>
        $MyParameter
    )
}

Then running Get-Help:

PS> Get-Help MyFunction -Parameter MyParameter

-MyParameter <Object>
    Parameter help content

    Required?                    false
    Position?                    1
    Default value
    Accept pipeline input?       false
    Accept wildcard characters?  false

from powershellpracticeandstyle.

That's exactly right. If you do not put a .PARAMETER MyParameter at the top or bottom of the function, then the comments directly above the parameter's definition will be used. I definitely think it's the best practice to do that -- keeping the documentation close to the definition makes it more likely to be kept up to date.

from powershellpracticeandstyle.