ProvideCommentHelp

poziom ważności: informacje

Opis

Pomoc oparta na komentarzach powinna być udostępniana dla wszystkich poleceń programu PowerShell. Ten test sprawdza tylko obecność pomocy opartej na komentarzach, a nie na ważności lub formacie.

Aby uzyskać pomoc dotyczącą pomocy opartej na komentarzach, użyj polecenia Get-Help about_comment_based_help lub następujących artykułów:

• pisanie pomocy opartej na komentarzach
• pisanie pomocy dotyczącej poleceń cmdlet programu PowerShell
• Tworzenie pomocy opartej na języku XML przy użyciu platformy PlatyPS

Konfiguracja

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

Parametry

• Enable: wartości logicznej (wartość domyślna to $true)

  Włącz lub wyłącz regułę podczas wywołania ScriptAnalyzer.

• ExportedOnly: wartości logicznej (wartość domyślna to $true)

  Jeśli to ustawienie jest włączone, zgłaszaj naruszenie tylko dla funkcji/poleceń cmdlet, które są eksportowane przy użyciu polecenia cmdlet Export-ModuleMember.

• BlockComment: wartości logicznej (wartość domyślna to $true)

  Jeśli to ustawienie jest włączone, zwraca pomoc dotyczącą komentarza w stylu bloku komentarza (<#...#>). W przeciwnym razie zwraca pomoc dotyczącą komentarza w stylu komentarza wiersza, w którym każdy wiersz komentarza zaczyna się od #.

• VSCodeSnippetCorrection: wartości logicznej (wartość domyślna to $false)

  Jeśli ta opcja jest włączona, zwraca pomoc dotyczącą komentarza w formacie fragmentu kodu vscode.

• : ciągu (wartość domyślna to )

  Reprezentuje położenie komentarza w odniesieniu do definicji funkcji.

  Możliwe wartości to:

  • before: oznacza, że pomoc jest umieszczana przed definicją funkcji
  • begin oznacza, że pomoc jest umieszczana na początku treści definicji funkcji
  • end oznacza, że pomoc umieszcza koniec treści definicji funkcji

  Jeśli zostanie podana jakakolwiek nieprawidłowa wartość, właściwość jest domyślnie ustawiona na before.

Przykład

Błędny

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

}

Poprawny

<#
.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
    (
        ...
    )

}