linter 规则——使用描述变量

该规则要求每个变量都必须有一个非空 @description 的装饰者。 清晰的描述解释了Bicep文件中计算数值的目的。

Linter 规则代码

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

use-description-vars

解决方案

以下变量不符合此规则，因为它没有描述：

var storageAccountName = '${namePrefix}storage'

为解决这个问题，可以添加一个非空 @description 装饰器：

@description('The name assigned to the storage account.')
var storageAccountName = '${namePrefix}storage'

后续步骤

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