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

Еще один способ улучшить читабельность вашего кода - использование комментариев. Комментарий - это понятное человеку объяснение или аннотация, написанная в сценарии оболочки.

Добавление комментариев к вашим сценариям Bash сэкономит вам много времени и усилий, если вы посмотрите на свой код в будущем. Допустим, вы хотите изменить сценарий, который вы написали несколько месяцев или лет назад. Скорее всего, вы не вспомните, почему написали какой-то сложный фрагмент кода, если не добавили комментарий.

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

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

В этой статье мы рассмотрим основы написания комментариев на Bash.

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

Bash игнорирует все, что написано после хеш-метки ( #) в строке. Единственное исключение из этого правила - первая строка в скрипте начинается с #!символов. Эта последовательность символов называется 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.

<< 'MULTILINE-COMMENT'
    Everything inside the
    HereDoc body is
    a multiline comment
MULTILINE-COMMENT

Использование HereDoc - это хак, а не настоящий встроенный способ написания многострочных комментариев Bash. Чтобы избежать каких-либо проблем, вы должны использовать однострочные комментарии.

Вывод

Написание комментариев является хорошей практикой и помогает другим разработчикам, в том числе будущему самому, понять сценарий оболочки. В Bash все после хеш-метки ( #) и до конца строки считается комментарием.