线条规则——使用描述类型

该规则要求用户自定义类型必须有非空 @description 的装饰器。清晰的描述说明你定义的类型目的。

注释

此规则默认关闭。在 bicepconfig.json 里更改电平以启用它。有 @discriminator 装饰师的类型不被这条规则评定。

Linter 规则代码

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

use-description-types

以下用户定义类型因无描述而未达此规则：

type StorageConfig = {
  name: string
  sku: string
}

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

@description('Configuration values for a storage account.')
type StorageConfig = {
  name: string
  sku: string
}

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