ProvideCommentHelp

Tingkat Keparahan : Informasi

Status default: Diaktifkan

Deskripsi

Aturan ini mendeteksi fungsi dan cmdlet yang tidak memiliki bantuan berbasis komentar. Setiap perintah PowerShell harus menyertakan bantuan berbasis komentar untuk mendokumentasikan tujuan, parameter, dan penggunaannya. PSScriptAnalyzer memeriksa keberadaan bantuan berbasis komentar, tetapi tidak memvalidasi konten atau formatnya.

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

Contoh

Tidak sesuai

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

}

Sesuai

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

}

Mengonfigurasi aturan

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

Parameter

Enable

Parameter ini mengontrol apakah ScriptAnalyzer memeriksa kode terhadap aturan ini. Ini menerima nilai boolean. Nilai defaultnya adalah $true.

Hanya Diekspor

Parameter ini mengontrol apakah pelanggaran dilaporkan hanya untuk fungsi dan cmdlet yang diekspor menggunakan Export-ModuleMember cmdlet. Ini menerima nilai boolean. Nilai defaultnya adalah $true.

Blokir Komentar

Parameter ini mengontrol gaya bantuan komentar yang dikembalikan oleh aturan. Ini menerima nilai boolean. Saat diatur ke $true, bantuan komentar dikembalikan dalam gaya komentar blokir (<#...#>). Saat diatur ke $false, bantuan komentar dikembalikan dalam gaya komentar baris di mana setiap baris komentar dimulai dengan #. Nilai defaultnya adalah $true.

VSCodeSnippetCorrection

Parameter ini mengontrol apakah bantuan komentar dikembalikan dalam format cuplikan Visual Studio Code. Ini menerima nilai boolean. Nilai defaultnya adalah $false.

Penempatan

Parameter ini mengontrol posisi bantuan komentar sehubungan dengan definisi fungsi. Ini menerima nilai string. Jika ada nilai yang tidak valid yang diberikan, properti akan default ke before. Nilai defaultnya adalah before.

Nilai yang mungkin adalah:

  • before: Komentar ditempatkan sebelum definisi fungsi
  • begin: Komentar ditempatkan di awal isi definisi fungsi
  • end: Komentar ditempatkan di akhir isi definisi fungsi
  • Terakhir diperbarui pada