Linter规则——使用描述输出

该规则要求每个输出都必须有一个非空 @description 的装饰器。 清晰的描述解释输出返回的值。

注释

此规则默认关闭。 在 bicepconfig.json 里更改电平以启用它。

Linter 规则代码

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

use-description-outputs

解决方案

以下输出不符合此规则,因为它没有任何描述:

output storageAccountName string = storageAccount.name

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

@description('The name of the deployed storage account.')
output storageAccountName string = storageAccount.name

后续步骤

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