首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >如何在Dockerfile中添加注释?

如何在Dockerfile中添加注释?
EN

Stack Overflow用户
提问于 2016-04-19 14:42:06
回答 6查看 197.8K关注 0票数 529

我正在写一个Dockerfile。有没有办法在这个文件中添加注释?

Docker是否有一个注释选项,可以取走行的其余部分并忽略它?

EN

回答 6

Stack Overflow用户

回答已采纳

发布于 2016-04-19 14:45:26

您可以在行首使用#来启动comment (允许在#之前使用空格):

代码语言:javascript
复制
# do some stuff
RUN apt-get update \
    # install some packages
    && apt-get install -y cron

字符串中间的#被传递给命令本身,例如:

代码语言:javascript
复制
RUN echo 'we are running some # of cool things'
票数 660
EN

Stack Overflow用户

发布于 2017-02-09 04:56:44

正如其他人提到的,注释是用#引用的,并且是documented here。但是,与某些语言不同的是,#必须位于行的开头。如果它们出现在行的中途,它们将被解释为参数,并可能导致意外的行为。

代码语言:javascript
复制
# This is a comment

COPY test_dir target_dir # This is not a comment, it is an argument to COPY

RUN echo hello world # This is an argument to RUN but the shell may ignore it

还应该注意的是,parser directives是最近添加到Dockerfile文件中的,它具有与注释相同的语法。它们需要出现在文件的顶部,在任何其他注释或命令之前。最初,添加此指令是为了更改转义字符以支持Windows:

代码语言:javascript
复制
# escape=`

FROM microsoft/nanoserver
COPY testfile.txt c:\
RUN dir c:\

虽然第一行看起来是注释,但它是一个解析器指令,用于将转义字符更改为反斜杠,以便COPYRUN命令可以在路径中使用反斜杠。解析器指令也可以与BuildKit一起使用,以通过syntax行更改前端解析器。有关如何在实践中使用它的更多详细信息,请参阅experimental syntax

使用多行命令时,注释的行将被忽略,但您需要逐个注释掉每一行:

代码语言:javascript
复制
$ cat Dockerfile
FROM busybox:latest
RUN echo first command \
# && echo second command disabled \
 && echo third command

$ docker build .
Sending build context to Docker daemon  23.04kB
Step 1/2 : FROM busybox:latest
 ---> 59788edf1f3e
Step 2/2 : RUN echo first command  && echo third command
 ---> Running in b1177e7b563d
first command
third command
Removing intermediate container b1177e7b563d
 ---> 5442cfe321ac
Successfully built 5442cfe321ac
票数 131
EN

Stack Overflow用户

发布于 2016-04-19 14:46:21

对注释使用#语法

来自:https://docs.docker.com/engine/reference/builder/#format

代码语言:javascript
复制
# My comment here
RUN echo 'we are running some cool things'
票数 20
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/36710459

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档