Linter 规则——使用描述参数

该规则要求每个参数的装饰器都必须非空 @description 。 清晰的描述通过记录每个输入的目的和期望值，提升模块和模板的可用性。

Linter 规则代码

请在 Bicep 配置文件中使用以下值自定义规则设置：

use-description-params

解决方案

以下示例不符合此规则，因为 storageAccountName 没有描述且 sku 描述为空：

param storageAccountName string

param location string = resourceGroup().location

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

你可以通过在每个参数中添加一个非空 @description 的装饰器来解决这个问题：

@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'

后续步骤

有关 Linter 的详细信息，请参阅使用 Bicep Linter。