Comment mettre un commentaire de ligne pour une commande multi-lignes

Question

Je sais comment écrire une commande multiligne dans un script de Bash, mais comment ajouter un commentaire pour chaque ligne dans une commande multiligne ?

CommandName InputFiles      \ # This is the comment for the 1st line
            --option1 arg1  \ # This is the comment for the 2nd line
            --option2 arg2    # This is the comment for the 3nd line

Mais malheureusement, le commentaire après le caractère de continuation \ interrompra la commande.

Answer 1

C'est comme ça que je fais. Essentiellement en utilisant le backtick de Bash. substitution de commande on peut placer ces commentaires n'importe où le long d'une longue ligne de commande, même si elle est divisée en plusieurs lignes. J'ai placé la commande echo devant votre exemple pour que vous puissiez exécuter l'exemple et voir comment il fonctionne :

echo CommandName InputFiles `#1st comment` \
             --option1 arg1 `#2nd comment` \
             --option2 arg2 `#3rd comment`

Un autre exemple où vous pouvez placer plusieurs commentaires à différents endroits sur une même ligne :

some_cmd --opt1 `#1st comment` --opt2 `#2nd comment` --opt3 `#3rd comment`

Answer 2

Vous pourriez stocker les arguments dans un tableau :

args=(InputFiles      # This is the comment for the 1st line
      # You can have whole lines of comments in between, useful for:
      #--deprecated-option # This isn't use any more
      --option1 arg1  # This is the comment for the 2nd line

      # And even blank lines in between for readability
      --option2 arg2  # This is the comment for the 3nd line
     )
CommandName "${args[@]}"

Cependant, je pense que cela semble un peu bidon si c'est uniquement dans le but de permettre des commentaires pour chaque argument. Par conséquent, je réécrirais simplement le commentaire pour qu'il fasse référence aux arguments individuels, et je le placerais au-dessus de la commande entière.

Answer 3

Je crains qu'en général, vous ne puissiez pas faire ce que vous demandez. Le mieux que vous puissiez faire est un commentaire sur les lignes avant la commande, ou un commentaire unique à la fin de la ligne de commande, ou un commentaire après la commande.

Vous ne pouvez pas réussir à intercaler des commentaires à l'intérieur d'une commande de cette manière. Le site \ expriment l'intention de fusionner des lignes, donc, à toutes fins utiles, vous essayez d'intercaler des commentaires dans une seule ligne, ce qui ne fonctionne pas de toute façon parce qu'un fichier \ doit être à la fin de la ligne pour avoir cet effet.

Answer 4

D'après le commentaire de pjh à une autre réponse à cette question en remplaçant IFS avec une variable connue pour ne pas contenir de caractères autres que des espaces blancs.

comment=
who ${comment# This is the command} \
    -u ${comment# This is the argument}

---

Pourquoi les expansions de paramètres ne sont-elles pas citées ? La variable est initialisée avec une chaîne vide. Lorsque l'expansion du paramètre se produit, la variable # (sans rapport avec le caractère de commentaire du shell # mais utilisé pour la similarité) tente de retirer le commentaire réel de la valeur du paramètre. Le résultat, bien sûr, est toujours une chaîne vide.

Une expansion de paramètre non citée subit un découpage de mots et une génération de nom de chemin. Dans ce cas, aucun de ces processus ne crée de mots supplémentaires à partir d'une chaîne vide, le résultat est donc toujours une chaîne vide. Une telle chaîne vide est simplement rejetée sans affecter la commande dans laquelle elle apparaît. Ce qui précède est précisément équivalent à

who \
  -u