Глeб Лeтушoв, рeдaктoр-фрилaнсeр, нaписaл стaтью спeциaльнo для блога Нетологии о том, как правильно оформлять программный код.
Один из важных моментов в разработке — качественное написание кода. С правильным оформлением удобно работать, потому что тратишь меньше времени на чтение и понимание кода.
Разбираем правила, которые подходят для разных языков программирования и помогают сделать код более понятным и чистым.
Используйте горизонтальные и вертикальные отступы
Комбинирование горизонтальных и вертикальных отступов — хороший тон в разработке. С их помощью выделяются отдельные циклы, функции и другие элементы.
Горизонтальный отступ проставляется с помощью двух или четырех пробелов для того, чтобы показать вложенность и выровнять элементы, например, переменную внутри условия.
var browser = prompt («ваш браузер»,»);
if (browser==«Сhrome»
|| browser==«Firefox»
|| browser==«Safari»
|| browser==«Opera») {
alert ('Хороший браузер');
}
Вертикальный отступ помогает наглядно разбить код на части. С помощью перевода строки можно разделить блоки внутри функции.
function checkNumber (Number) {
if (Number 33) {
return true;
} else {
return confirm ('Номер маленький');
}
}
Восемь-девять строк подряд делают код менее читаемым, поэтому различные части лучше отделять помощью отступов.
Не превышайте оптимальную длину строки
Максимальная длина строки — 80 символов. Если их больше, то читать и понимать код становится тяжелее.
Когда количество символов превышает оптимальное, код лучше разбить на несколько строк.
Правильно используйте фигурные скобки
Так же, как и отступы, важно правильно использовать фигурные скобки. Есть два общепринятых метода.
-
Ставить скобки сразу после кода:
var password = prompt («Введите Ваш пароль», «отмена»);
if (pass == «qwerty») {
alert («Успешная авторизация»);
} else if (prompt == null) {
alert («Авторизация не удалась»);
} else {
alert («Пароль неверный»);}
}
-
Ставить скобки параллельно друг с другом:
var password = prompt («Введите Ваш пароль», «отмена»);
if (pass == «qwerty»)
{
alert («Успешная авторизация»);
}
else if (prompt == null)
{
alert («Авторизация не удалась»);
}
else
{
alert («Пароль неверный»);
}
}
Начинающие программисты часто пропускают фигурные скобки, а если пользоваться одним из этих наглядных методов, то место с пропуском найти легко.
Называйте переменные и функции на английском
Английские названия короче и их легче писать. В больших компаниях могут работать люди из разных стран, и названия на английском будут понятны всем.
Правильно:
var password
var UserName
function Sum ()
function Send ()
Неправильно:
var parol
var ImyaPolzovatelja
function Summa ()
function Otpravka ()
Названия, написанные транслитом, будут вносить путанницу в код. Одно и то же слово можно по-разному написать транслитом: ssilka, ssylka.
Составляйте названия из несколько слов
Названия должны быть понятными. Чтобы этого добиться, иногда лучше использовать несколько слов.
Слова в названиях нельзя разделять пробелом, поэтому существуют другие способы разделения.
-
Новое слово пишется слитно с предыдущим и начинается с большой буквы:
var paddingHeight
function showResult ()
Такой стиль написания называется CamelCase (верблюжья нотация).
-
Слово соединяется через знак нижнего подчеркивания:
var pading_height
function show_Result ()
Имя переменной — существительное
Название переменной описывает данные, которые в ней хранятся. Поэтому переменные удобно называть существительными, которые отвечают на вопрос «что?».
var productName
var baseLink
Название функции — глагол
Так как функция выполняет действие, то ее обозначают глаголом.
Для обозначения сложной функции удобно использовать несколько слов. Первое — простой глагол, который показывает характер действия, второе уточняет это действие.
checkValue ()
findSolution ()
Одна функция должна выполнять одно действие, которое указано в названии. Если действие в функции сложное, лучше разделить его на несколько функций.
Комментарии к коду
Комментарии — это важная часть программирования. Правильно написанный комментарий делает код более понятным и объясняет, почему задача решена так, а не иначе.
Комментировать лучше по мере разработки, а не на последнем этапе. В конце сложнее вспомнить, как работает нужный алгоритм и что повлияло на его выбор.
Если отдельная строка кода непонятна без комментария, ее лучше переписать — оптимизировать код и сделать его очевидней.
Заключение
Не всегда эти правила работают так, как нужно. Но они помогают сделать код читабельным и легким для понимания. Это хороший тон в программировании.
Мнение автора и редакции может не совпадать. Хотите написать колонку для «Нетологии»? Читайте наши условия публикации.
