Regola di Linter - usa i parametri di descrizione

Questa regola richiede che ogni parametro abbia un decoratore non vuoto @description . Descrizioni chiare migliorano l'usabilità di moduli e modelli documentando lo scopo e il valore atteso di ogni input.

Codice regola Linter

Usare il valore seguente nel file di configurazione Bicep per personalizzare le impostazioni delle regole:

use-description-params

Soluzione

Il seguente esempio non supera questa regola perché storageAccountName non ha descrizione e sku ha una descrizione vuota:

param storageAccountName string

param location string = resourceGroup().location

@description('')
param sku string = 'Standard_LRS'

Puoi risolvere il problema aggiungendo un decoratore non vuoto @description a ciascun parametro:

@description('Name of the storage account.')
param storageAccountName string

@description('Location for all resources.')
param location string = resourceGroup().location

@description('Storage account SKU name.')
param sku string = 'Standard_LRS'

Passaggi successivi

Per ulteriori informazioni su linter, vedere Usare linter di Bicep.