Старайтесь, чтобы программу было легко читать.
• Хорошо комментируйте свою программу. Это не значит просто: “Добавьте много комментариев”. Вы не можете сформулировать смысл операции на естественном языке лучше, чем на языке программирования. В комментариях следует ясно и коротко указать то, что невозможно выразить в коде.
• Название программы.
• Цель программы.
• Кто написал программу и зачем.
• Номера версий.
• Какие фрагменты кода могут вызвать сложности.
• Основные идеи.
• Как организован код.
• Какие предположения сделаны относительно вводных данных.
• Каких фрагментов кода пока не хватает и какие варианты еще не обработаны.
• Используйте осмысленные имена.
• Это не значит: “Используйте длинные имена”.
• Используйте логичную схему кода.
• Ваша интегрированная среда программирования может помочь, но она не может сделать за вас всю работу.
• Воспользуйтесь стилем, принятым в книге.
• Разбивайте программу на небольшие фрагменты, каждый из которых выражает определенную логическую операцию.
• Старайтесь, чтобы функция не превышала больше одной-двух страниц; большинство функций будет намного короче.
• Избегайте сложных выражений.
• Пытайтесь избегать вложенных циклов, вложенных инструкций if, сложных условий и т.д. К сожалению, иногда они необходимы, поэтому помните, что в сложном коде легче всего спрятать ошибку.
• Используйте, где только можно, библиотечные функции, а не собственный код.
• Библиотеки, как правило, лучше продуманы и протестированы, чем ваши собственные программы.
Пока все эти советы звучат довольно абстрактно, но скоро мы покажем примеры их применения.
Скомпилируйте программу. Разумеется, для этого понадобится компилятор. Его сообщения обычно весьма полезны, даже если мы хотели бы лучшего, и если вы не профессионал, то должны считать, что компьютер всегда прав. Если же вы реальный эксперт, то закройте книгу — она написана не для вас. Иногда программисту кажется, что правила компилятора слишком тупые и слишком строгие (как правило, это не так), и многие вещи можно было бы сделать проще (как бы не так). Однако, как говорится, “свой инструмент проклинает только плохой мастер”. Хороший мастер знает сильные и слабые стороны своего инструмента и соответственно его настраивает. Рассмотрим наиболее распространенные ошибки компиляции.
• Закрыта ли кавычка строки литералов?
cout << "Привет, << name << '\n'; // Ой!
• Закрыта ли кавычка отдельного литерала?
cout << "Привет, " << name << '\n; // Ой!
• Закрыта ли фигурная скобка блока?
int f(int a)
{
if (a>0) {/* что-то делаем */ else {/* делаем что-то
другое */}
} // Ой!
• Совпадает ли количество открывающих и закрывающих скобок?
if (a<=0 // Ой!
x = f(y);
Компилятор обычно сообщает об этих ошибках “поздно”; он просто не знает, что вы имели в виду, когда забыли поставить закрывающую скобку после нуля.
• Каждое ли имя объявлено?
• Включены ли все необходимые заголовочные файлы (например,
#include "std_lib_facilities.h"
)?
• Объявлено ли каждое имя до его использования?
• Правильно ли набраны все имена?
int count; /* ... */ ++Count; // Ой!
char ch; /* ... */ Cin>>c; // Ой-ой!
• Поставлена ли точка с запятой после каждой инструкции?
x = sqrt(y)+2 // Ой!
z = x+3;
В упражнениях мы привели еще больше примеров таких ошибок. Кроме того, помните о классификации ошибок, указанной в разделе 5.2.
После того как программа скомпилирована, а ее связи отредактированы, наступает самый трудный этап, на котором необходимо понять, почему программа работает не так, как вы предполагали. Вы смотрите на результаты и пытаетесь понять, как ваша программа могла их вычислить. На самом деле чаще программисты смотрят на пустой экран и гадают, почему их программа ничего не вывела. Обычная проблема с консолью Windows заключается в том, что она исчезает, не дав вам шанса увидеть, что было выведено на экран (если что-то все-таки было выведено). Одно из решений этой проблемы — вызвать функцию
keep_window_open()
из заголовочного файла
std_lib_facilities.h
в конце функции
main()
. В таком случае программа попросит вас ввести что-нибудь перед выходом, и вы сможете просмотреть результаты ее работы до того, как окно закроется. В поисках ошибок тщательно проверьте инструкцию за инструкцией, начиная с того места, до которого, по вашему мнению, программа работала правильно. Встаньте на место компьютера, выполняющего вашу программу. Соответствует ли вывод вашим ожиданиям? Разумеется, нет, иначе вы не занимались бы отладкой.
• Часто, когда программист не видит проблемы, причина заключается в том, что вы видите не действительное, а желаемое. Рассмотрим пример.
for (int i = 0; i<=max; ++j) { // Ой! (Дважды)
for (int i=0; 0<max; ++i); // Выводим элементы вектора v
cout << "v[" << i << "]==" << v[i] << '\n';
Последний пример позаимствован из реальной программы, написанной опытным программистом (я подозреваю, что он писал этот фрагмент глубокой ночью).
• Часто, когда вы не видите проблемы, причина заключается в том, что между точкой, где программа еще работала правильно, и следующей точкой, где программа выдала неверный ответ, содержится слишком много инструкций (или выводится слишком мало информации). Большинство интегрированных сред программирования допускают пошаговую отладку программ. В конце концов, вы научитесь пользоваться этими возможностями, но при отладке простых программ достаточно расставить в нескольких местах дополнительные инструкции вывода (с помощью потока cerr). Рассмотрим пример.
int my_fct(int a, double d)
{
int res = 0;
cerr << "my_fct(" << a << "," << d << ")\n";
// ...какой-то код...
cerr << "my_fct() возвращает " << res << '\n';
