Программирование на языке си ( с ) | C Sharp (Си шарп) с нуля. Сортировки | Массивы | Функции

Стили программирования — Комментарии | Стилевое единство в языке Си

   Комментарии

Комментарии нужны для облегчения чтения кода, но при неправильном использовании этого сильного средства можно только усложнить читабельность кода. Например, комментируя те моменты, которые и так всем понятны.

Не надо писать о вещах, которые всем понятны:

/* Оператор i++ увеличивает значение i на единицу */
for (int i=0; ;i++)
{
   ...
}

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

Комментируйте функции и глобальные данные.

/* Функция меняет значения данных */
void swap (int x, int y)
{
   int z = x;
   x = y;
   y = z;
}

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

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

Старайтесь писать качественный код, и надобность в комментариях будет минимальной.

   Стилевое единство в языке си

Задача правильно расставлять скобки кажется на первый взгляд просто смешной. Но на самом деле этот момент очень важен, так же как и вопрос об отступах. Нужно ли делать 2 или 3 или, вообще, 4 пробела? Ответа на эти вопросы однозначного нет, программисты и по сей день спорят, но все равно каждый остается верен своему стилю программирования.

Выбирайте сами, что вам больше по душе и пользуйтесь этим, что б у вас отложилось на подзоснательном уровне ваше стилевое единство языка си.

Нужно ли ставить фигурные скобки, когда мы используем всего один оператор? Этот вопрос так же достаточно интересен и так же ответа на него однозначного нету. Но все же, фигурные скобки облегчают чтение участка программы. На личном примере испытал немало ошибок из-за того что ленился лишний раз поставить фигурные скобки, а при добавлении второго оператора забывал о них.

if (a == 10) {
   cout << "123";
}
//ИЛИ
if (a == 10)
   cout << "123";

Вопрос Стилевого единства является самым неоднозначным. Но все же какой бы путь вы не выбрали, он в разы облегчит вам жизнь в написании программ.

Рекомендации:

  1. Первая программа на языке си - ее полный разбор
  2. Стиль программирования - Имена
При копировании ( использовании ) материала размещайте ссылку на сайт www.mir-koda.ru