CodeStyle

Введение

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

В нашем проекте мы не требуем наличия единого стиля для всех программ всех задач всех студентов. Однако, выбрав для решения задачи некоторый стиль кода, необходимо его придерживаться как минимум до конца решения во всех её файлах.

Что такое стиль кода

Что это такое и почему это важно http://ru.wikipedia.org/wiki/Стандарт_оформления_кода

Обратная сторона http://ru.wikipedia.org/wiki/Спагетти-код

Принципы

Ещё раз: данные принципы не являются железными правилами. Однако они отличают профессиональный код от любительского.

Элемент стиля	Принцип и почему важно
Язык кода	Строки в программах, комментарии, имена файлов должны быть на английском. Несколько причин, почему: 1. Проблемы с кодировками при передаче файлов. 2. Проблемы при работе в международных проектах, в которых не все участники понимают русский.
Длина строк должна быть разумно ограничена	Настройки редакторов у разных людей отличаются, и у читателя ваша строка может не поместиться на экран. Разбивайте длинные строки на несколько коротких. Обычно приемлемым считается ширина текста 80 символов
Комментарии к функциям	Для определения каждой функции должно быть краткое введение, что она делает, какие аргументы принимает и какие значения возвращает. Иначе читателю трудно без углубления в ваш код понять связи между его частями
Комментарии к отдельным строкам	Очень тонкое искусство. Следует пояснять те строки кода, в которых делаются вещи, которые могут быть непонятны читателю, например, используются числовые константы, адресная арифметика
Табуляция и пробелы для отступов	Используйте для отступов или только табуляцию, или только пробелы, но никогда смесь. У читателя кода могут быть другие настройки редактора, что разрушит структуру, которая у вас стройна. Размер табуляции может быть или 4, или 8 пробелов
Имена переменных	Используйте имена, объясняющие смысл переменной. В крайнем случае давайте комментарий, для чего переменная служит