ProvideCommentHelp

livello di gravità : informazioni

Descrizione

Questa regola rileva funzioni e cmdlet che non hanno assistenza basata sui commenti. Ogni comando PowerShell dovrebbe includere un aiuto basato su commenti per documentare il suo scopo, i parametri e l'utilizzo. PSScriptAnalyzer verifica la presenza di aiuti basati sui commenti ma non ne convalida il contenuto o il formato.

Per assistenza sull'aiuto basato sui commenti, usa il comando Get-Help about_comment_based_help o fai riferimento a queste risorse:

Esempio

Non conforme

function Get-File
{
    [CmdletBinding()]
    Param
    (
        ...
    )

}

Compliant

<#
.Synopsis
    Short description
.DESCRIPTION
    Long description
.EXAMPLE
    Example of how to use this cmdlet
.EXAMPLE
    Another example of how to use this cmdlet
.INPUTS
    Inputs to this cmdlet (if any)
.OUTPUTS
    Output from this cmdlet (if any)
.NOTES
    General notes
.COMPONENT
    The component this cmdlet belongs to
.ROLE
    The role this cmdlet belongs to
.FUNCTIONALITY
    The functionality that best describes this cmdlet
#>

function Get-File
{
    [CmdletBinding()]
    Param
    (
        ...
    )

}

Configurazione

Rules = @{
    PSProvideCommentHelp = @{
        Enable = $true
        ExportedOnly = $false
        BlockComment = $true
        VSCodeSnippetCorrection = $false
        Placement = 'before'
    }
}

Parametri

Enable

Questo parametro controlla se ScriptAnalyzer verifica il codice rispetto a questa regola. Accetta un valore booleano. Il valore predefinito è $true.

Solo esportato

Questo parametro controlla se le violazioni vengono segnalate solo per funzioni e cmdlet esportati tramite il Export-ModuleMember cmdlet. Accetta un valore booleano. Il valore predefinito è $true.

Blocca Commento

Questo parametro controlla lo stile dell'aiuto dei commenti restituito dalla regola. Accetta un valore booleano. Quando impostato su $true, l'aiuto ai commenti viene restituito in stile a blocchi commenti (<#...#>). Quando impostato su $false, l'aiuto ai commenti viene restituito in stile commento a riga, dove ogni riga inizia con #. Il valore predefinito è $true.

VSCodeSnippetCorrection

Questo parametro determina se l'aiuto ai commenti viene restituito in formato di snippet di Visual Studio Code. Accetta un valore booleano. Il valore predefinito è $false.

Collocazione

Questo parametro controlla la posizione dell'aiuto del commento rispetto alla definizione della funzione. Accetta un valore di stringa. Se viene specificato un valore non valido, per impostazione predefinita la proprietà viene before. Il valore predefinito è before.

I valori possibili sono:

  • before: Il commento viene posto prima della definizione della funzione
  • begin: Il commento è posto all'inizio del corpo della definizione della funzione
  • end: Il commento è posto alla fine del corpo di definizione della funzione
  • Last updated on