# — начало комментария в Bash

Для того, чтобы написать программу не требуется знать, что такое комментарии, и даже про то, что они вообще существуют. Но для того, чтобы написать программу, которую могут читать другие, (а не только выполнять компьютер), комментарии нужны, полезны и даже для автора программы. Так как программа пишется конечное количество времени. А после этого, как правило, просто запускается. Но, если в системе что-то поменялось, то иногда требуется внести изменения и в программный код. И вот тогда, правильно и к месту написанные комментарии, помогут быстрее разобраться, как и что работает и где и что нужно дописать, удалить или поправить.

В Bash, как и в любом другом языке программирования предусмотрена возможность оставлять комментарии. Принцип комментирования очень прост: «Всё, что начинается с символа # и до конца строки считается комментарием.»

Не редко можно отрыть программу и узнать о том, кто её написал, с какой целью, когда, какая это версия программы, где можно более прочитать о том, как она работает и для чего предназначена... А также массу полезной (и не очень) информации. =)

Так выглядит обычный комментарий на языке программирования Bash:

# Это обычный комментарий Bash и тут может быть написано что угодно.
# Может быть несколько строк комментариев.
# Это никак не влияет на выполнение кода программы.
# Но тут может быть и полезная информация.

Однако, этим полезность комментариев далеко не исчерпывается. Комментарии можно использовать для описания того, что происходит в самом коде, например:

# Объявление переменных 
fixPrmCnt=0   # Счетчик фиксированных параметров 
pInter=       # Интерактивный режим 
pLogFile=     # Имя лог-файла 
pUpdate=      # Режим обновления

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

У комментариев есть ещё одна полезная функция, которую часто используют при программировании. Это экранирование кода, который по каким-то причинам не нужно использовать. И тогда это может выглядеть так:

# Параметр нужен только при определённых уловиях
# Если эти условия наступили, просто раскомментируйте сроку ниже
# parameter = On

Такой приём позволяет упросить код программы, сократив некоторые проверки, которые могли бы усложнить программу или заметно замедлить её выполнение. А, возможно, автору программы было просто лень писать все проверки и он ввёл режим «ручного управления».

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

Правильно закомментированная программа — это большое спасибо того, кто с ней работает тому, кто оставил комментарии за экономию времени на работу с ней. Те, кто пытался разобраться в коде чужих программ, меня поймут. =)

Заберите ссылку на статью к себе, чтобы потом легко её найти!
Раз уж досюда дочитали, то может может есть желание рассказать об этом месте своим друзьям, знакомым и просто мимо проходящим?
Не надо себя сдерживать! ;)