Способ создания многострочных комментариев в Bash?

Недавно я начал изучать сценарий оболочки, и я хотел бы иметь возможность закомментировать ряд строк в сценарии оболочки. Я имею в виду, как в случае с C / Java:

/* comment1
   comment2 
   comment3
*/`

Как я мог это сделать?

Используйте, : 'чтобы открыть и 'закрыть.

Например:

: '
This is a
very neat comment
in bash
'

Многострочный комментарий в bash

: <<'END_COMMENT'
This is a heredoc (<<) redirected to a NOP command (:).
The single quotes around END_COMMENT are important,
because it disables variable resolving and command resolving
within these lines.  Without the single-quotes around END_COMMENT,
the following two $() `` commands would get executed:
$(gibberish command)
`rm -fr mydir`
comment1
comment2 
comment3
END_COMMENT

Я обновляю этот пост на основе комментариев и других ответов, поэтому комментарии до 22 мая 2020 года могут больше не применяться.

Bash не предоставляет встроенный синтаксис для многострочного комментария, но есть хаки, использующие существующий синтаксис bash, который «работает сейчас».

Лично я думаю, что самый простой (то есть наименее шумный, наименее странный, самый простой в наборе, наиболее явный) - это использовать цитируемый HEREDOC, но сделать очевидным, что вы делаете, и везде использовать один и тот же маркер HEREDOC:

<<'### BLOCK COMMENT'
line 1
line 2

line 3
line 4
### BLOCK COMMENT

Одиночные кавычки маркера HEREDOC позволяют избежать некоторых побочных эффектов синтаксического анализа оболочки, таких как странные ситуации, которые могут вызвать сбой или вывод, и даже анализ самого маркера. Таким образом, одинарные кавычки дают вам больше свободы для маркера комментариев открытия-закрытия. Например, следующее использует тройной хеш, который предлагает многострочный комментарий в bash. Это может привести к сбою сценария, если одинарные кавычки отсутствуют. Даже если вы удалите ###, FOO{}сценарий будет аварийно завершен (или приведет к неправильной замене, если нет set -e), если бы не одиночные кавычки:

set -e

<<'### BLOCK COMMENT'
something something ${FOO{}} something
more comment
### BLOCK COMMENT

ls

Вы могли бы, конечно, просто использовать

set -e

<<'###'
something something ${FOO{}} something
more comment
###

ls

но цель этого определенно менее ясна для читателя, незнакомого с этим обманом.

В настоящее время любой хороший редактор позволяет вам нажать ctrl- / или подобный, чтобы отменить / прокомментировать выбор. Все определенно понимают это:

# something something ${FOO{}} something
# more comment
# yet another line of comment

хотя по общему признанию, это не так удобно, как блок комментариев выше, если вы хотите заново заполнить свои абзацы.

Конечно, есть и другие методы, но, похоже, не существует «обычного» способа сделать это. Было бы хорошо, если бы ###>и ###<можно было добавить к bash, чтобы указать начало и конец блока комментариев, кажется, что это может быть довольно просто.

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

<< ////

Usage:
This script launches a spaceship to the moon. It's doing so by 
leveraging the power of the Fifth Element, AKA Leeloo.
Will only work if you're Bruce Willis or a relative of Milla Jovovich.

////

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

Конечно, "////"это просто строка; количество косых черт в префиксе и суффиксе должно быть одинаковым.

что вы думаете об этом?

function giveitauniquename()
{
  so this is a comment
  echo "there's no need to further escape apostrophes/etc if you are commenting your code this way"
  the drawback is it will be stored in memory as a function as long as your script runs unless you explicitly unset it
  only valid-ish bash allowed inside for instance these would not work without the "pound" signs:
  1, for #((
  2, this #wouldn't work either
  function giveitadifferentuniquename()
  {
    echo nestable
  }
}

Вот как я делаю многострочные комментарии в bash.

У этого механизма есть два преимущества, которые я ценю. Во-первых, комментарии могут быть вложенными. Другое - блоки можно включить, просто закомментировав начальную строку.

#!/bin/bash
# : <<'####.block.A'
echo "foo {" 1>&2
fn data1
echo "foo }" 1>&2
: <<'####.block.B'
fn data2 || exit
exit 1
####.block.B
echo "can't happen" 1>&2
####.block.A

В приведенном выше примере блок «B» закомментирован, но части блока «A», которые не являются блоком «B», не закомментированы.

Выполнение этого примера приведет к следующему выводу:

foo {
./example: line 5: fn: command not found
foo }
can't happen

Я попробовал выбранный ответ, но обнаружил, что при запуске сценария оболочки, имеющего его, все это выводилось на экран (аналогично тому, как на ноутбуках jupyter все выводилось в '''xx'''кавычках), и в конце появлялось сообщение об ошибке. Он ничего не делал, но: страшно . Тогда я понял, редактируя его, что одинарные кавычки могут занимать несколько строк. Итак ... давайте просто назначим блок переменной.

x='
echo "these lines will all become comments."
echo "just make sure you don_t use single-quotes!"

ls -l
date

'

Простое решение, не слишком умное:

Временно заблокировать часть скрипта:

if false; then
    while you respect syntax a bit, please
    do write here (almost) whatever you want.
    but when you are
    done # write
fi

Немного сложная версия:

time_of_debug=false # Let's set this variable at the beginning of a script

if $time_of_debug; then # in a middle of the script  
    echo I keep this code aside until there is the time of debug!
fi

# Мне нравится лень и простота. Я бы использовал # с забавным обходным решением:

1 НАЖМИТЕ:] find ctrl + F или cmd + F или что-то еще [чтобы активировать функцию поиска

2 используйте регулярное выражение в поле поиска, например: (^.+)

3 заменить на: # $1или, если вы предпочитаете#$1

# Примечание: у вас может не быть трех шагов в вашем редакторе. В этом случае используйте онлайн-инструмент для регулярных выражений (не могу предложить его здесь по соображениям политики):

1. Выберите, скопируйте текст, где бы вы ни находились, и вставьте его в онлайн-инструмент регулярных выражений.
2. Использовать (^.+)как регулярное выражение и / #$1или #\1как шаблоны замещения
3. Выберите, скопируйте текст и вставьте его туда, где вы начали

# Наслаждайтесь вашими хэшами!