Как сделать комментарий в файле Docker?

Question

Я пишу файл Dockerfile, и я хочу знать, есть ли способ сделать комментарии в этом файле? Есть ли у docker опция комментариев, которая берет остальную часть строки и игнорирует ее?

Answer 1

use # to comment a line.

# Everything on this line is a comment 

Answer 2

Dockerfile комментарии начинаются с '#', как и python. Вот хороший пример: https://github.com/kstaken/dockerfile-examples/blob/master/mongodb/Dockerfile

# Install a more up to date 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"] 

Answer 3

Используйте # синтаксис для комментариев

От: https://docs.docker.com/engine/reference/builder/#format

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

Answer 4

Как уже упоминалось, комментарии ссылки с # и documented here , Однако, в отличие от некоторых языков, # должен быть в начале строки. Если они происходят частично через линию, они интерпретируются как аргумент и могут приводить к неожиданному поведению.

# This is a comment 

COPY test_dir target_dir # this is not a comment, it is an arg to COPY 

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

Следует также отметить, что parser directives недавно были добавлены в Dockerfile, которые имеют тот же синтаксис, как комментарий. Они должны появляться в верхней части файла, перед любыми другими комментариями или командами. В настоящее время только директива для изменения экранирующего символа поддержки окна:

# escape=` 

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

Первой строки, в то время как это, кажется, комментарий, директива парсера, чтобы изменить характер побега к кавычке так, что Команды COPY и RUN могут использовать обратную косую черту в пути.