Как новичок, я всегда думал, что работа с кодом важнее того, насколько хорошо он имеет отступ. После того, как я писал код около года, я понял, насколько важно писать хороший код. Хороший код здесь означает не только отступы, но и то, как ваш код выглядит для других. Это будет включать в себя то, как вы называете переменную, куда вы добавляете комментарии и многое другое. Начнем с отступа.
Что такое отступ?
В языках компьютерного программирования отступы используются для форматирования исходного кода программы, чтобы улучшить читаемость. Отступы обычно используются только программистами; компиляторы и интерпретаторы редко заботятся о том, сколько пробелов присутствует между операторами программирования. Однако некоторые языки программирования полагаются на использование отступов для разграничения структуры программирования, часто с использованием разновидности правила оффсайда. Таким образом, в языках программирования Haskell, Occam и Python используются отступы.
Посмотрим на псевдокод:
main() {
variable declaration;
for loop {
another for loop {
yet another for loop {
some work to be done;
another work;
}
again some work;
}
damn some more work;
}
}
Кажется ужасным? Хм? Думаете, кто действительно так кодирует в реальной жизни? И это больно. Чем больше смотришь, тем больнее. Теперь посмотрим на его брата с отступом:
main() {
variable declaration;
for loop {
another for loop {
yet another for loop {
some work to be done;
another work;
}
again some work;
}
damn some more work;
}
}
Когда мы смотрим на этот код, мы можем ясно видеть, что внутри нашего main () у нас есть вложенный цикл for. Это определенно более читабельно и понятно, чем его неграмотный / плохо управляемый брат. Итак, теперь вы поняли, о чем я говорю.
Как использовать в коде хорошие отступы?
1. Интервал
Интервал является наиболее важной частью отступов и форматирования кода. Это также делает код более читабельным при правильном обслуживании. Поэтому мы должны соблюдать правильные интервалы во всем коде, и они должны быть последовательными.
Несколько советов:
За всеми именами массивов сразу должна стоять левая квадратная скобка.
// NOT Recommended
arr [0];
// Recommended
arr[0];
Все бинарные операторы должны сохранять пространство по обе стороны от оператора.
// NOT Recommended
a=b-c;
a = b-c;
a=b - c;
// Recommended
a = b - c;
// NOT Recommended
z = 6*x + 9*y;
// Recommended
z = 6 * x + 9 * y;
z = (7 * x) + (9 * y);
Все броски должны быть написаны без пробелов.
// NOT Recommended
(ClassA) m.get(3);
( ClassA )m.get(3);
// Recommended
(ClassA)m.get(3);
2. Максимальная длина строки
Попробуйте установить максимальную длину строки для вашего кода. Максимальная длина строки не должна превышать 120 символов. Если его нужно увеличить, поместите его в другую строку. Причина в том, что возможности редакторов и типографии. В общем, обычные редакторы и принтеры могут без труда обрабатывать 120 символов. Поэтому, если он превышает предел, это становится проблемой для самого редактора кода. Постарайтесь, чтобы строки кода были примерно одинаковой длины. Это сделает код симметричным и организованным.
3. Самодокументирующийся код:
Много раз мы слышали, что каждый фрагмент кода должен быть должным образом задокументирован, чтобы его можно было легко понять. И начинаем писать поверх него детали метода. Но это не лучшая практика. Потому что код может быть изменен в будущем, а программист забыл изменить документацию. Поэтому лучше всего писать код таким образом, чтобы он мог объяснять себя без каких-либо комментариев.
// NOT recommended
if ( (a == Good) && ( (b == better) || (b == best) ) )
// Recommended
boolean isbetterbest = ( (b == better) || (b == best) );
if ( (a == Good) && isbetterbest )
4. Использование комментариев
Постарайтесь объяснить свою логику простыми словами, чтобы другим было удобно читать. С помощью комментариев у вас будет меньше вопросов относительно вашего кода и логики. Однострочные комментарии, добавленные в приведенные выше фрагменты, являются лучшими примерами, чтобы донести до читателя, о чем ваш код.
Преимущества хорошего отступа
Некоторые веские причины использовать отступы.
- Показывает уровни вложенности, вложенных операторов if, циклов for и т. д.
Как показано выше, отступы в вашем коде говорят вам, когда и что внутри чего вложено. Сбивает с толку? Например, вы запросили WAP, который принимает ввод всех элементов 2D-массива. Простейшая логика гласит: вы будете использовать цикл for / while и внутри этого другого цикла for / while. Таким образом, написание кода с правильным отступом поможет вам определить уровень вложенности.
- Показывает объем:
Понятно, что если все написано с отступом, вы знаете объем переменных. Как и в приведенном выше примере, если код имеет отступ, вы можете легко понять, какие переменные и где доступны. И это также показывает, где конкретный блок начинается и где он заканчивается.
- Любой, кто читает ваш код, может сказать, что внутри чего выполняется:
Очевидно, вы не будете использовать свой собственный код в изолированной камере на всю жизнь, не говорите, что будете. Вы, очевидно, поделитесь своим кодом (пока вы не станете фанатом Windows / Apple), и другие прочитают его и, возможно, захотят его изменить. А для того, чтобы иметь возможность вносить изменения, необходимо понимать поток выполнения программы, что возможно только в том случае, если код правильно отформатирован, прокомментирован и имеет отступ.
- Легче читать:
Я не думаю, что мне нужно объяснять этот момент. Если вам все еще нужно объяснение, еще раз прочтите два приведенных выше примера.
Заключение
Из вышеизложенного становится очень ясно, что при написании даже 20-строчной программы отступы экономят много времени, которое можно было бы потратить на повторное чтение и понимание. Это также увеличивает удобочитаемость для других, а также для программиста. Мы также осознали важность написания хорошего кода с лучшими практиками отступов и форматирования. Мы должны помнить, что при кодировании необходимо соблюдать правильное правило отступов, чтобы программа была легко читаемой и поддерживаемой в будущем. Таким образом, мы можем сделать вывод, что отступы и форматирование являются важной частью практики программирования, и разработчики должны следовать им с самого начала своей карьеры в программировании.
Nameste 🙏
