UseSupportsShouldProcess

Tingkat Keparahan : Peringatan

Status default: Selalu diaktifkan

Deskripsi

Aturan ini mendeteksi deklarasi WhatIf manual dan Confirm parameter dalam fungsi dan cmdlet. Alih-alih mendeklarasikan parameter ini secara manual, Anda harus menggunakan CmdletBinding atribut dengan SupportsShouldProcess sebagai argumen bernama.

Pendekatan ini secara otomatis menyediakan kedua parameter bersama dengan fungsionalitas bawaan yang memberi Anda dan pengguna pengalaman interaktif yang konsisten. Penggunaan SupportsShouldProcess lebih mudah dipelihara dan memberikan perilaku standar tanpa kode tambahan.

Contoh

Tidak sesuai

function foo {
    param(
        $param1,
        $Confirm,
        $WhatIf
    )
}

Sesuai

function foo {
    [CmdletBinding(SupportsShouldProcess)]
    param(
        $param1
    )
}

Mengonfigurasi aturan

Aturan ini selalu diaktifkan dan tidak dapat dikonfigurasi. Gunakan salah satu metode berikut untuk menghindari penggunaan aturan ini:

  • Buat file konfigurasi aturan kustom untuk hanya menyertakan aturan yang Anda inginkan atau kecualikan aturan yang tidak Anda inginkan.
  • Tambahkan atribut penekanan aturan yang sesuai ke kode Anda untuk menekan aturan untuk blok kode tertentu. Untuk informasi selengkapnya, lihat bagian Menekan aturanMenggunakan PSScriptAnalyzer.