无效定义描述

注意
此检查处于实验阶段，默认情况下未启用。要启用它，请参见实验性检查。

输出

Comment for build stage or argument should follow the format: `# <arg/stage name> <description>`. If this is not intended to be a description comment, add an empty line or comment between the instruction and the comment.

描述

docker build 命令的 --call=outline 和 --call=targets 标志会打印构建目标和参数的描述。这些描述是从 Dockerfile 注释生成的，这些注释紧接在FROM或ARG指令之前，并以构建阶段或参数的名称开头。例如

# build-cli builds the CLI binary
FROM alpine AS build-cli
# VERSION controls the version of the program
ARG VERSION=1

在不希望前面的注释作为描述的情况下，请在指令和前面的注释之间添加空行或注释。

示例

❌ 错误：FROM命令前一行有非描述性注释。

# a non-descriptive comment
FROM scratch AS base

# another non-descriptive comment
ARG VERSION=1

✅ 正确：空行分隔非描述性注释。

# a non-descriptive comment

FROM scratch AS base

# another non-descriptive comment

ARG VERSION=1

✅ 正确：描述ARG键和紧接命令之前的阶段的注释。

# base is a stage for compiling source
FROM scratch AS base
# VERSION This is the version number.
ARG VERSION=1