Comment puis-je faire un commentaire dans un Dockerfile?

Je suis en train d'écrire un Dockerfile. Est-il un moyen de faire des commentaires dans ce fichier?

Ne Docker avez un commentaire option qui prend le reste de la ligne et l'ignore?

InformationsquelleAutor kpie | 2016-04-19

337

Vous pouvez utilisez le # pour commenter une ligne.
```
# Everything on this line is a comment
```
- Donc la réponse à la deuxième question, "Ne Docker avez un commentaire option qui prend le reste de la ligne et l'ignore?", n'est pas? "Docker traite les lignes qui commencent par # un commentaire".
- Pouvez-vous mettre à jour votre réponse et de le rendre plus complet/complet? Par exemple, en répondant à la deuxième question.
- BMitch réponse comble de l'information critique, ce qui manque à cette réponse.
InformationsquelleAutor Ranjeet
57

Comme d'autres l'ont mentionné, les commentaires sont référencées par un # et sont documenté ici. Cependant, contrairement à certaines langues, le # doit être au début de la ligne. Si elles se produisent à mi-chemin à travers la ligne, ils sont interprétés comme un argument et peut entraîner un comportement inattendu.
```
# 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
```
Il convient également de noter que analyseur de directives ont récemment été ajoutées à la Dockerfile qui ont la même syntaxe que pour un commentaire. Ils doivent apparaître en haut du fichier, avant tout autre commentaire ou des commandes. A l'origine, cette directive a été ajouté pour changer le caractère d'échappement à la prise en charge de Windows:
```
# escape=`

FROM microsoft/nanoserver
COPY testfile.txt c:\
RUN dir c:\
```
La première ligne, alors qu'il semble être un commentaire, est un analyseur de la directive de changer le caractère d'échappement pour un backtick de sorte que le COPY et RUN commandes peuvent utiliser la barre oblique inverse dans le chemin d'accès. Un analyseur de la directive est également utilisé avec BuildKit de changer l'interface de l'analyseur avec un syntax ligne. Voir la expérimentale de la syntaxe pour plus de détails sur la façon dont elle est utilisée dans la pratique.

Avec un multi-ligne de commande, les lignes commentées sont ignorés, mais vous avez besoin de commenter chaque ligne individuellement:
```
$ 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
```
- Merci pour une réponse plus complète
- +1 pour la mention "doit être au début de la ligne". Ce sujet de la continuation de ligne? Si une ligne de commentaire se termine par \, sera la prochaine ligne aussi être un commentaire? En d'autres termes, si un multi-ligne de commande pour être commenté, aurait toutes les lignes doivent commencer avec # ou seulement sur la première ligne? Une expérience suggère que c'est l'ancien. Cette réponse pourrait être mis à jour pour couvrir aussi bien (ce qui rend encore plus impressionnant).
- Le commentaire est nécessaire sur chaque ligne, docker ignore complètement tout jusqu'à la fin de ligne. Ce qui est intéressant pour moi, c'est que le multi de ligne de commande peut s'étendent à travers les commentaires.
InformationsquelleAutor BMitch
15

Utiliser le # syntaxe pour les commentaires

À partir de: https://docs.docker.com/engine/reference/builder/#format
```
# My comment here
RUN echo 'we are running some cool things'
```
- mais pouvons-nous en commentaire sur la même ligne que EXÉCUTER, de COPIER, de RESPONSABLE, etc?
- Oui selon les docs que j'ai lié à commentaires en ligne sont valables ADD . $foo # ADD . /bar
- notez toutefois que le fait de changer le commentaire à la fin de la ligne va provoquer le panneau de relancer cette ligne sur un panneau construire, parce que la "ligne de a changé". Cela peut être utile et/ou ennuyeux
- Très bon point, peut-être docker doit ignorer le commentaire lol
- Qui est à la fois une fonction et un bug, je suppose que le Panneau de considérer une fonction, et je pense que cela a du sens en fait
- Peut-être une réponse à la deuxième question, avec un exemple?
InformationsquelleAutor edhurtig

Dockerfile les commentaires commencent par"#", tout comme Python.
Voici un bon exemple (kstaken/dockerfile-exemples):

# 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"]

Oui, mais contrairement à Python n'est pas le reste de la ligne avec une commande en début de ligne? Vous souhaitez mettre à jour votre réponse.

InformationsquelleAutor DhruvPathak

0

Format

Ici est le format de la Dockerfile:

Nous pouvons utiliser # pour commenter but#Comment par exemple
```
#FROM microsoft/aspnetcore
FROM microsoft/dotnet
COPY /publish /app
WORKDIR /app
ENTRYPOINT ["dotnet", "WebApp.dll"]
```
À partir du fichier ci-dessus lorsque nous construisons le docker, il ignore la première ligne et passe à la ligne suivante, car nous avons fait des observations à l'aide de #

InformationsquelleAutor Ben.Bean

Vous devez vous connecter pour publier un commentaire.

Format