ProvideCommentHelp

Tingkat Keparahan : Info

Deskripsi

Bantuan berbasis komentar harus disediakan untuk semua perintah PowerShell. Pengujian ini hanya memeriksa keberadaan bantuan berbasis komentar dan bukan pada validitas atau format.

Untuk bantuan tentang bantuan berbasis komentar, gunakan perintah Get-Help about_comment_based_help atau artikel berikut:

• Menulis Bantuan Berbasis Komentar
• Menulis Bantuan untuk Cmdlet PowerShell
• Membuat bantuan berbasis XML menggunakan platyPS

Konfigurasi

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

Parameter

• : bool (Nilai defaultnya adalah )

  Aktifkan atau nonaktifkan aturan selama pemanggilan ScriptAnalyzer.

• : bool (Nilai defaultnya adalah )

  Jika diaktifkan, lempar pelanggaran hanya pada fungsi/cmdlet yang diekspor menggunakan cmdlet Export-ModuleMember.

• : bool (Nilai defaultnya adalah )

  Jika diaktifkan, mengembalikan bantuan komentar dalam gaya komentar blokir (<#...#>). Jika tidak, mengembalikan bantuan komentar dalam gaya komentar baris di mana setiap baris komentar dimulai dengan #.

• : bool (Nilai defaultnya adalah )

  Jika diaktifkan, mengembalikan bantuan komentar dalam format cuplikan vscode.

• : string (Nilai defaultnya adalah )

  Mewakili posisi bantuan komentar sehubungan dengan definisi fungsi.

  Nilai yang mungkin adalah:

  • before: berarti bantuan ditempatkan sebelum definisi fungsi
  • begin berarti bantuan ditempatkan di awal isi definisi fungsi
  • end berarti bantuan menempatkan akhir isi definisi fungsi

  Jika ada nilai yang tidak valid yang diberikan, properti akan default ke before.

Contoh

Salah

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

}

Benar

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

}