Спосіб створення багаторядкових коментарів у 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

Я спробував обрану відповідь, але виявив, що запустив сценарій оболонки, маючи його, вся справа надрукувалася на екран (подібно до того, як зошити юпітера роздруковують все в '''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 ПРЕСС:] знайдіть ctrl + F або cmd + F або будь-яку іншу [, щоб запустити функцію пошуку

2 використовуйте регулярний вираз у полі пошуку, наприклад: (^.+)

3 замініть на: # $1або якщо ви хочете#$1

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

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

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