如何在Dockerfile中做注释?

我正在写一个Dockerfile。有办法在这个文件中做注释吗?

Docker是否有一个注释选项来接受一行的剩余部分并忽略它?

246217 次浏览

你可以在一行的开头使用#来开始一个评论(允许在#之前有空格):

# do some stuff
RUN apt-get update \
# install some packages
&& apt-get install -y cron

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

RUN echo 'we are running some # of cool things'
Dockerfile注释以#开头,就像Python一样。 # EYZ0: < / p >
# Install a more-up-to date version of MongoDB than what is included in the default Ubuntu repositories.


FROM ubuntu
MAINTAINER Kimbro Staken


RUN apt-key adv --keyserver keyserver.ubuntu.com --recv 7F0CEB10
RUN echo "deb http://downloads-distro.mongodb.org/repo/ubuntu-upstart dist 10gen" | tee -a /etc/apt/sources.list.d/10gen.list
RUN apt-get update
RUN apt-get -y install apt-utils
RUN apt-get -y install mongodb-10gen


#RUN echo "" >> /etc/mongodb.conf


CMD ["/usr/bin/mongod", "--config", "/etc/mongodb.conf"]

注释使用#语法

来自:# EYZ0

# My comment here
RUN echo 'we are running some cool things'

正如其他人所提到的,注释是用#记录在这里引用的。但是,与某些语言不同的是,#必须位于行首。如果它们出现在整行中,则将它们解释为参数,并可能导致意外的行为。

# 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

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

# escape=`


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

第一行虽然看起来是注释,但实际上是一个解析器指令,用于将转义字符更改为反撇号,以便COPYRUN命令可以在路径中使用反斜杠。解析器指令还与BuildKit一起使用,用syntax行更改前端解析器。有关如何在实践中使用它的更多细节,请参阅实验的语法

使用多行命令,被注释的行将被忽略,但是你需要单独注释掉每一行:

$ 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

格式

下面是Dockerfile:的格式

我们可以使用#进行注释,例如#COMMENT

#FROM microsoft/aspnetcore
FROM microsoft/dotnet
COPY /publish /app
WORKDIR /app
ENTRYPOINT ["dotnet", "WebApp.dll"]

当我们构建docker时,从上面的文件中,它会跳过第一行并进入下一行,因为我们使用#注释了它

Docker将#开始作为注释,除非 Line是一个有效的解析器指令。一行中任何位置的#标记

示例代码:

# this line is a comment


RUN echo 'we are running some # of cool things'

输出:

we are running some # of cool things
# this is comment
this isn't comment

就是这样做的。你可以把它放在行中的任何地方,后面的任何内容都将被忽略