Skip to content

Latest commit

 

History

History
34 lines (19 loc) · 3.27 KB

shell.md

File metadata and controls

34 lines (19 loc) · 3.27 KB

Руководство по оформлению shell-скриптов

Содержание:

  • Правила именования скриптов
  • Правила именования переменных

Правила именования скриптов

Имена файлов задаются в нижнем регистре.

Пробелы не принято использовать потому что в таком случае нужно заключать имя файла в кавычки ("foo bar") или экранировать пробелы (foo\ bar).

Вместо пробела может использоваться тире. Например: /usr/bin/ssh-keygen. К слову сказать, в веб-разаботке также используется символ тире в названиях файлов потому что подчеркивание ссылок может скрыть символы подчеркивания в названии файла.

Также вместо пробела может использоваться символ подчеркивания.

camelCase является антипаттерном на UNIX-подобных ОС.

Расширение .sh использовать для исполняемых программ необязательно потому что они обозначаются битом исполнения (execute bit) и оболочка (shell) знает как запускать различные типы программ. Тем не менее расширение файла отображает его тип и может быть полезно для подсветки. Google строго рекомендует не использовать .sh расширение.

Правила именования переменных

Переменные окружающей среды или переменные оболочки, которые добавляются операционной системой или скриптами из автозагрузки оболочки обычно пишутся в верхнем регистре.

Для того чтобы предотвратить конфликты собственных переменных с вышеупомянутыми является хорошей практикой использовать нижний регистр для своих переменных. Вместо пробела используется символ подчеркивания. Можно использовать lower_case или camelCase.

Важно постоянство использования выбранного варианта, а не сам вариант написания.

Список использованных источник