Введение
При написании сценариев Bash всегда полезно сделать код чистым и простым для понимания. Организация кода в блоки, создание отступов, присвоение описательных имен переменным и функциям — вот несколько способов сделать это.
Еще один способ улучшить читаемость кода — использовать комментарии. Комментарий — это удобочитаемое объяснение или аннотация, написанная в сценарии оболочки.
Добавление комментариев к сценариям Bash сэкономит вам много времени и усилий при просмотре вашего кода в будущем. Допустим, вы хотите изменить сценарий, который написали несколько месяцев или лет назад. Скорее всего, вы не вспомните, зачем написали сложный фрагмент кода, если не добавили комментарий.
Комментарии также помогают другим разработчикам и системным администраторам, которым может потребоваться сопровождение сценария, понять код и его назначение.
Комментарии обычно используются для объяснения того, чего код не может. Например, если у вас есть сложное регулярное выражение или подстановка параметров в вашем скрипте Bash, вы должны написать комментарий о том, что делает код. Комментарии должны быть краткими и по существу. Не объясняйте то, что просто и очевидно для читателя.
В этой статье мы рассмотрим основы написания комментариев в Bash.
Пишите комментарии в Bash
Bash игнорирует все, что написано после знака решетки ( # ) в строке. Единственное исключение из этого правила — когда первая строка скрипта начинается с i #! персонажи. Эта последовательность символов называется Shebang и используется, чтобы указать операционной системе, какой интерпретатор использовать для анализа остальной части файла.
Комментарии можно добавлять в начале строки или в строке с другими кодами:
# This is a Bash comment.
echo "This is Code" # This is an inline Bash comment.
Пробел после решётки не обязателен, но улучшит читаемость комментария.
Обычно при открытии скрипта в текстовом редакторе комментарии отображаются зеленым цветом.
Комментарии также полезны при тестировании скрипта. Вместо того, чтобы удалять несколько строк или блоков, вы можете прокомментировать их:
# if [[ $VAR -gt 10 ]]; then
# echo "Variable is greater than 10."
# fi
Многострочные комментарии в Bash
В отличие от большинства языков программирования, Bash не поддерживает многострочные комментарии.
Самый простой способ написать многострочные комментарии в Bash — добавить отдельные комментарии один за другим:
# This is the first line.
# This is the second line.
Другой вариант — использовать HereDoc. Это тип перенаправления, который позволяет вам передать несколько строк ввода в команду. Если блок HereDoc не перенаправляется на команду, он может выступать в качестве заполнителя для многострочных комментариев:
<< 'MULTILINE-COMMENT'
Everything inside the
HereDoc body is
a multiline comment
MULTILINE-COMMENT
Использование HereDoc — это хак, а не встроенный способ написания многострочных комментариев Bash. Во избежание проблем предпочтительно использовать однострочные комментарии.
Вывод
Написание комментариев является хорошей практикой и помогает другим разработчикам, в том числе самому себе из будущего, понять сценарий оболочки. В Bash все, что следует за знаком решетки ( # ) и до конца строки, считается комментарием.
