При написании Bash-скриптов всегда рекомендуется делать код понятным и понятным. Этого можно добиться, организовав код в блоки, используя отступы и присваивая переменным и функциям описательные имена.
Ещё один способ улучшить читаемость кода — использовать комментарии. Комментарий — это понятное человеку пояснение или примечание, написанное внутри скрипта оболочки.
Добавление комментариев к вашим Bash-скриптам сэкономит вам массу времени и сил при последующем просмотре кода. Например, если вы захотите изменить скрипт, написанный несколько месяцев или лет назад, вы можете не вспомнить, почему написали тот или иной фрагмент кода, пока не добавите комментарий. Таким образом, добавление комментариев к коду поможет вам лучше его понять и упростит внесение будущих изменений.
Комментарии также помогают другим разработчикам и системным администраторам, которым может потребоваться поддержка скрипта, понять ваш код и его назначение.
Комментарии используются для пояснения кода. Например, если в вашем Bash-скрипте есть сложное регулярное выражение или подстановка параметров, следует написать комментарий, описывающий, что делает этот код. Комментарии должны быть краткими и по существу. Воздержитесь от объяснения того, что и так понятно и понятно читателю.
В этой статье мы рассмотрим основы написания комментариев в Bash.
Написание комментариев в Bash
Bash игнорирует всё, что написано в строке после символа решётки ( # ). Единственное исключение из этого правила — когда первая строка скрипта начинается с символов #! Эта последовательность символов называется «шебанг» и сообщает операционной системе, какой интерпретатор использовать для анализа оставшейся части файла.
Комментарии можно добавлять в начале строки или внутри другого кода:
# 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 всё после символа решётки ( # ) и до конца строки считается комментарием.
Если у вас есть вопросы или пожелания, не стесняйтесь оставлять комментарии.
Связанные руководства