ИТ Блог. Администрирование серверов на основе Linux (Ubuntu, Debian, CentOS, openSUSE)

Написание комментариев в скриптах Bash

Bash Heredoc

Комментарии являются неотъемлемой частью любого языка программирования или сценариев. Bash не отличается.

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

В этом совете bash мы покажем вам три способа добавления комментариев в сценарий оболочки:

 

Однострочные комментарии в скрипте bash

Любая строка, начинающаяся с ключа # hash/pound, рассматривается как комментарий в bash. Единственным исключением из этого правила является #! который является shebang и используется, чтобы указать, какая оболочка будет использоваться для обработки сценария.

Давайте посмотрим это на примере скрипта bash:

#!/bin/bash

#Определите переменные здесь
message="Hello"
day=$(date +%A)

#Печать некоторых сообщений
echo "$message $USER! Сегодня день$. Приятного вам дня!"
echo "Пока.!"

 

Как видите, в приведенном выше примере есть два однострочных комментария.

 

Встроенные комментарии в bash-скрипте

Вы также можете добавить встроенные комментарии в скриптах bash. Вместо того, чтобы начинать строку с #, добавьте комментарий, начинающийся с # в конце строки кода.

Вот пример:

#!/bin/bash

message="Hello"
day=$(date +%A) #При этом будет напечатан только день, а не вся дата и время

echo "$message $USER! Сегодня день$. Приятного вам дня!"
echo "Пока.!"

 

Мы добавили встроенный комментарий в строку, где была объявлена ​​переменная day. Это говорит о том, что команда date с +%A покажет только текущий день.

Мы удалили другие комментарии, чтобы избежать путаницы.

 

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

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

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

#!/bin/bash

<<Block_comment
message="Hello"
day=$(date +%A) #При этом будет напечатан только день, а не вся дата и время

echo "$message $USER! Сегодня день$. Приятного вам дня!"
Block_comment

echo "Пока.!"

 

Если вы запустите приведенный выше скрипт, он напечатает только. До свидания, пока! ». Весь код между << Block_comment и Block_comment игнорируется.

Если вы отлаживаете свой код и хотите закомментировать блоки кода, вы можете использовать его. В противном случае не используйте его в основных сценариях, потому что это не встроенная функция оболочки.

Надеюсь, вам понравится этот быстрый совет по написанию комментариев в сценарии оболочки. Ваши вопросы и предложения всегда приветствуются.

Exit mobile version