Хороший стиль программирования Форматирование кода Стиль программирования

Хороший стиль программирования Форматирование кода

Стиль программирования - набор приемов или методов программирования, которые используют программисты, чтобы получить правильные, эффективные, удобные для применения программы, а так же он существенно влияет на читаемость программного кода и количество ошибок программирования. Форматирование — это ключ к структуре программы. Компьютеру важна исключительно информация о скобках или операторах, а читатель-человек склонен делать выводы из визуального представления кода.

Цели хорошего форматирования кода Хорошая схема форматирования должна делать следующие вещи: 1. Точно представлять логическую структуру кода. Для демонстрации логической структуры программисты обычно применяют отступы и другие неотображаемые символы. 2. Единообразно показывать логическую структуру кода. 3. Улучшать читабельность. 4. Выдерживать процедуру исправления. Исправление одной строки не должно приводить к изменению нескольких других.

Способы форматирования Неотображаемые символы, к которым относятся пробелы, знаки табуляции, переводы строк и пустые строки, — это основное средство для демонстрации структуры программы. Способ применения неотображаемых символов — выделение связанных между собой конструкций в отдельный блок. Кроме необходимости группировать взаимосвязанные операторы, очень важно отделять несвязанные выражения друг от друга. Для этого можно использовать пустые строки. Они позволяют продемонстрировать организацию программы. Можно использовать их для деления групп взаимосвязанных операторов, отделения методов друг от друга и выделения комментариев. Логический блок - группа подходящих друг к другу операторов. Можно отделять их друг от друга с помощью пустых строк. Отступы применяются для демонстрации логической структуры программы. Как правило, операторы выделяются отступами, когда они следуют после некоторого выражения, от которого они логически зависят. Скобки применяются для разъяснения выражений, состоящих из двух и более членов. Возможно, в скобках нет нужды, но они добавляют ясности в код. Пример:

Форматирование строк, длина операторов/выражений. Длина строки не должна превышать 80 символов. Если аргументы функции не помещаются на одной строке, их следует разбивать на несколько строк. Пример: В сложных выражениях нужно размещать каждое условие на отдельной строке. Пример: Незавершенность выражения должна быть очевидна. Например, можно поместить оператор соединяющий выражения в начале новой строки. Пример:

Не нужно выравнивать правые части выражений присваивания, в дальнейшем поддержка такого форматирования может привести только к пустой трате времени. Пример (не нужное выравнивание): Расположение только одного оператора на строке. Это даст следующее: 1. Точное представление о сложности программы. 2. Если операторы расположены на отдельных строках, чтение кода происходит сверху вниз, без необходимости чтения слева на право. 3. При размещении операторов на отдельных строках легко найти синтаксические ошибки, если компилятор сообщает только номера строк, где они произошли. При расположении нескольких операторов на одной строке ее номер ничего не скажет о том, какой оператор содержит ошибку. 4. Когда строка содержит только один оператор, его легко редактировать — можно удалить или временно закомментировать всю строку.

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

Функции должны быть короткими и понятными, делать что-то одно, но хорошо. Не должно быть большого количества локальных переменных, нормальное количество 5 -10. Если их больше, возможно, стоит задуматься над разбиением функции на две или более функции. Функции отделяются друг от друга двумя пустыми строками. Тип, имя функции и параметры пишутся на одной строке, если для записи параметров не достаточно места, то часть параметров переносится на новую строку. Имя функции не отделяется от скобки. Между типом возвращаемого значения и именем функции ставится один пробел. В списке аргументов, аргументы отделяются одним пробелом после запятой. При объявлении функции необходимо указывать осмысленные имена аргументов. При пустом списке аргументов пробелов в скобках не должно быть. Пример:

if/else, do, while Расстановка скобок соответствует формату явных блоков. Пример: Расстановка скобки так, что бы не было "висячих" операторов else, лучше всегда выделять скобками блоки кода, даже когда скобки могут быть опущены. Пример: else if следует писать так: Пример: do. . . while Пример:

Операции Необходимо вставлять пробел между операциями присваивания, логическими и арифметическими операциями Пример: Не оставлять пробела после унарной операции. Пример:

Примеры форматирования : До: После: Единственное различие между этими двумя кусками кода заключается в расстановке пробелов и переносов строк - в остальном код совершенно одинаков. Пробелы и разрывы строк нужны исключительно людям. Машина читает все эти куски кода одинаково легко.

Выполнила: Студентка группы 11 -ИД-5 Садовникова Елена