Жанр: Учеба
Правила программирования на Си и Си плюс плюс.
...будет предложение else,
расположенное на следующем экране или странице, довольно велика. И
если я допустил в нем ошибку, то мне придется поломать голову над тем,
как добраться до else. Если в это время if в поле зрения, то я знаю, как
туда попасть.
58. Старайтесь сдвинуть ошибки с этапа выполнения
на этап компиляции
Неинициализированные переменные - по сути ошибки, ждущие своего
часа. Вы всегда должны инициализировать переменную при ее
объявлении. В Си++ инициализация во время объявления возможна
всегда, потому что объявление может проводиться везде, где можно
поместить оператор; просто откладывайте объявление до тех пор, пока у
вас не будет достаточно информации для объявления в произвольном
месте с инициализацией переменной. Таким образом, если вы
попытаетесь использовать эту переменную преждевременно, то получите
ошибку на этапе компиляции ("переменная не найдена") вместо ошибки
во время выполнения.
В Си вы можете объявлять переменную после любой открытой
Правила обычного программирования 81
фигурной скобки, поэтому вы можете часто откладывать объявление на
некоторое время, но при этом у вас в распоряжении нет гибкости Си++. В
самом крайнем случае инициализируйте переменную таким значением,
которое в ответ на него понятным образом вызовет в подпрограмме
аварию; не присваивайте переменной произвольное значение - оно
может быть принято в программе за имеющее смысл. Например,
указатель, инициализированный значением NULL, более надежен, чем
имеющий произвольное значение, которое может оказаться
существующим адресом.
С другой стороны, хорошо иметь все объявления переменных в одном
месте в начале блоке так, чтобы вы могли их легко найти. Если ваша
подпрограмма достаточно мала, то вы обычно можете сделать и то, и
другое. Например, вы можете разделить подпрограмму на части для того,
чтобы переместить объявления в начало блока, чтобы вам их было легче
найти. Подпрограмма, подобная следующей:
f()
{
// код, который не использует переменную i
int i = init_val;
// код, который использует переменную i
}
может быть разделена следующим образом:
f()
{
// код, который не использует переменную i
g( init_val );
}
g( int init_val )
{
int i = init_val;
// код, который использует переменную i
}
Переменная-счетчик общего назначения, которая инициализируется в
начале цикла for, является очевидным исключением из этого правила.
Иногда использование слишком большого количества подпрограмм
может вызвать больше проблем, чем решить их, и в этом случае лучше
выбрать внутренние объявления. Используйте свою голову.
59. Применяйте указатели на функции Си в
Переменная, объявленная в операторе for, не выживает после этого оператора.
- Ред.
Правила программирования на Си и Си++
82
качестве селекторов
Это правило строго для программистов на Си. (Программирующие на
Си++ должны использовать виртуальные функции). В Си заменяйте
подобный код:
typedef enum shape_type { CIRCLE, LINE, TEXT };
typedef struct
{
shape_type type;
union shape_data
{ // здесь данные для различных форм.
} data;
} shape;
extern void print_circle( shape *p );
extern void print_line ( shape *p );
extern void print_text ( shape *p );
shape a_circle = { CIRCLE, ... };
print_shape( shape *p )
{
switch
( p-"type )
{
case CIRCLE: print_circle( p );
case LINE: print_line ( p );
case TEXT: print_text ( p );
}
}
на следующий:
typedef struct
{
void (*print)( struct *shape );
union shape_data;
{ // здесь данные для различных фигур.
}
}
shape;
extern void print_circle( shape *p );
extern void print_line ( shape *p );
extern void print_text ( shape *p );
shape a_circle = { print_circle, ... };
print_shape( shape *p )
{
( p-"type )( p );
}
Правила обычного программирования 83
Главные преимущества такого подхода заключаются в следующем:
+ Вам больше не нужен перечислитель shape_type.
+ Функцию print_shape() теперь написать гораздо проще.
+ print_shape() будет продолжать работать без модификации, когда
вы добавите новые фигуры в эту систему.
60. Избегайте циклов do/while
Цикл do/while опасен в принципе, так как вы обязательно выполняете
его тело хотя бы один раз. Следовательно, вы должны проверить условия
завершения до входа в этот цикл. Я часто вижу код, похожий на
следующий:
if
( !
проверить_нечто )
return ERROR;
do
{
начинка();
} while( проверить_нечто );
Вам гораздо лучше сделать так:
while
( проверить_нечто )
начинка();
Похожий случай:
if
( некое_условие() )
do
// масса материала
while
( некое_условие() && другой_материал() );
легче трактовать следующим образом:
while
( некое_условие() )
{
// масса материала
if
( !
другой_материал() )
break
;
}
Я профессионально занимаюсь программированием с 1979 года и за это
время использовал цикл do/while всего два раза.
Правила программирования на Си и Си++
60.1. Никогда не используйте do/while для
бесконечного цикла
Код, похожий на следующий:
do
{
// здесь следует несколько страниц кода
} while( 1 );
просто заставляет сопровождающего программиста шарить по листингу
взглядом, ища while, вместо того, чтобы найти его сразу в случае
расположения оператор while (1) в начале цикла.
61. В цикле со счетчиком его значение должно по
возможности уменьшаться
Циклы являются одним из тех мест, где малое повышение эффективности
значительно улучшает выполнение программы, потому что их код
выполняется многократно. Так как сравнение с нулем обычно более
эффективно, чем сравнение с определенным числом, то цикл с
уменьшающимся счетчиком, как правило, выполняется быстрее.
Используйте
for
( i = max; --i "= 0; )
;
вместо:
for
( i = 0; i " max; ++i )
;
Заметьте, что в обоих случаях счетчики могут быть использованы в
качестве действительного индекса массива, что может сделать этот код
менее подверженным ошибкам вследствие того, что он ограничивает
доступ к массиву его границами.
62. Не делайте одно и то же двумя способами
одновременно
В качестве контрапункта к предыдущему правилу рассмотрим следующий
фрагмент (содержащий в себе ошибку):
int array[ARRAY_SIZE];
int *p = array;
for
( i = 1; i " ARRAY_SIZE ; ++i )
*p++ = 0;
Правила обычного программирования 85
Проблема состоит в том, что счетчик не совпадает по фазе с указателем (i
имеет значение 1, когда указатель указывает на элемент array[0]), и
последний элемент массива не будет инициализирован.
Я обычно предпочитаю для простых перемещений по массивам
указатели (вместо индексов массива), потому что указатели, как правило,
более эффективны, устраняя неявную операцию умножения в выражении
a[i]
, интерпретируемом как:
( a + ( i* sizeof(a[0])))
Я бы переписал это код таким образом:
int array[ARRAY_SIZE];
int *current = array;
int *const end = array + (SIZE-1);
while
( current "= end )
*current++ = 0;
Так же надежно (хотя и менее эффективно) сделать следующее:
int array[ARRAY_SIZE];
int i;
for
( i = 0; i " ARRAY_SIZE ; ++i )
array[i] = 0;
Кстати, если вы используете указатели, то вам придется извлекать индекс
при помощи арифметики указателей, а не за счет сохранения второй
переменной. У вас могут возникнуть проблемы, если вы передадите i
функции в предыдущем примере с ошибкой. Воспользуйтесь подобным
кодом:
for
( current = array; current "= end; ++current )
{
// ...
f( current - array ); // передать функции f() текущий
// индекс массива
}
С другой стороны, обычно нужно избегать кода, подобного следующему,
так как такой оператор цикла чрезвычайно неэффективен:
while
( (current - array) " ARRAY_SIZE )
// ...
63. Используйте оператор for, если имеются любые
два из инициализурующего, условного или
инкрементирующего выражений
Иначе используйте while. Такой код:
int x = 10;
Правила программирования на Си и Си++
// далее следует 200 строк кода, в которых переменная x не
// используется
while
( x " 0 )
{
// снова следует 200 строк кода
f( x-- );
}
не очень хорош, даже если вы сэкономили немного времени, соединив
операцию декрементирования — с вызовом функции. Переместите
инициализацию и x-- в оператор for. Так как объявление в Си++ может
располагаться везде, где можно поместить оператор, то вы даже можете
объявить x непосредственно перед for:
int x = 10;
for ( ; x " 0 ; --x )
{
// следует 200 строк кода
f(x);
}
(И хотя вы можете сказать, что в Си++ есть возможность сделать for (
int
=0;...
, такая практика вводит в заблуждение, потому что на самом
деле область видимости у x внешняя, как если бы ее объявление было
сделано в строке, предшествующей оператору for. Я не рекомендую
этого).
Если три оператора внутри for слишком длинны, чтобы поместиться в
одной строке, то вы можете их отформатировать их следующим образом:
for
( некое_длинное_имя_переменной = f();
некое_длинное_имя_переменной ;
некое_длинное_имя_переменной = f() )
{
// ...
}
но часто лучше выделить одно из предложений вот так:
int некое_длинное_имя_переменной = f();
for
(; некое_длинное_имя_переменной;
некое_длинное_имя_переменной = f() )
{
// ...
}
Кроме того, стандарт пересмотрел подход к жизни переменных, объявленных в
операторе for. - Ред.
Правила обычного программирования 87
или в чрезвычайном случае
int некое_чрезвычайно_длинное_имя_переменной = f();
for
(; ; некое_чрезвычайно_длинное_имя_переменной = f() )
{
if
( !
некое_чрезвычайно_длинное_имя_переменной )
break
;
// ...
}
Главное - это сосредоточить инициализацию, проверку и
инкрементирование в одном месте. Я никогда не сделаю так:
int некое_чрезвычайно_длинное_имя_переменной = f();
while
( некое_чрезвычайно_длинное_имя_переменной )
{
// много строк кода
некое_чрезвычайно_длинное_имя_переменной = f();
}
потому что это нарушает контроль над циклом.
64. То, чего нет в условном выражении, не должно
появляться и в других частях оператора for
Так как оператор for предназначен для того, чтобы собрать
инициализирующую, условную и инкрементирующие части цикла в
одном месте, так чтобы вы могли, взглянув, понять, что происходит, то вы
не должны загромождать оператор for материалом, который не имеет
отношения к циклу, иначе вы лишите смысла всю эту конструкцию.
Избегайте подобного кода:
int *ptr;
// ...
for
( ptr = array, i = array_size; --i "= 0; f(ptr++) )
;
который лучше сформулировать так:
int *ptr = array;
for
( i = array_size; --i "= 0 ; )
f( ptr++ );
65. Допускайте, что ситуация может измениться в
худшую сторону
Одним из лучших примеров этой проблемы связан со "знаковым
расширением". Большинство компьютеров используют так называемую
арифметику "двоичного дополнения". Крайний левый бит отрицательного
числа в этой арифметике всегда содержит 1. Например, восьмибитовый
Правила программирования на Си и Си++
тип char со знаком, содержащий число -10, будет представлен в машине
с двоичным дополнением как 11110110 (или 0xf6). То же самое число в
16-битовом типе int представлено как 0xfff6. Если вы преобразуете 8битовый
char в int явно посредством оператора приведения типов или
неявно, просто используя его в арифметическом выражении, где второй
операнд имеет тип int, то компилятор преобразует char в int, добавляя
второй байт и дублируя знаковый бит (крайний слева) char в каждом
бите добавленного байта. Это и есть знаковое расширение.
Существуют два вида операций сдвига вправо на уровне языка
ассемблера: "арифметический сдвиг" дает вам знаковое расширение (то
значение, что было в крайнем левом бите до сдвига, будет в нем и после
сдвига); "логический сдвиг" заполняет левый бит нулем. Данное правило,
независимо от того, арифметический или логический сдвиг у вас, когда
вы используете оператор сдвига Си/Си++, звучит очень просто: если вам
требуется знаковое расширение, то допустите, что у вас получится
заполнение нулями. А если вам нужно заполнение нулями, то
представьте, что у вас получилось знаковое расширение.
Другим хорошим примером являются возвращаемые коды ошибок.
Удивительное количество программистов не заботится о проверке того,
не вернула ли функция malloc() значение NULL при недостатке
свободной памяти. Быть может, они полагают, что имеется бесконечный
объем виртуальной памяти, но известно, что ошибка может с легкостью
вызвать резервирование всей имеющейся памяти, и вы никогда не
обнаружите этого, если не будете проверять возвращаемые коды ошибок.
Если функция может индицировать состояние ошибки, то вы должны
допустить, что ошибка произойдет, по меньшей мере, однажды за время
жизни программы.
66. Компьютеры не знают математики
Компьютеры - это арифметические инструменты, славные счетные
машины. Они не знают математики. Поэтому даже такие простые
выражения, как следующее, могут добавить вам хлопот:
int x = 32767;
x = (x * 2)/ 2;
(На 16-разрядной машине x получится равным -1.32767 - это 0x7fff.
Умножение на 2 - на самом деле сдвиг влево на один бит, дает в
результате 0xfffe - отрицательное число. Деление на два является
арифметическим сдвигом вправо с гарантированным знаковым
расширением, и так вы получаете теперь 0xffff или -1). Поэтому важно
каждый раз при выполнении арифметических вычислений учитывать
Правила обычного программирования 89
ограничения компьютерной системы. Если вы производите умножение
перед делением, то при этом рискуете выйти за пределы разрядности при
сохранении результата; если вы сначала делите, то рискуете случайно
округлить результат до нуля; и так далее. Численным методам для
компьютеров посвящены целые книги, и вам нужно прочитать хотя бы
одну из них, если в ваших программах много математики.
Вы также должны знать мелкие грехи своего языка программирования.
В Си, например, преобразование типов выполняется по принципу
"оператор за оператором". Я однажды потратил утро, пытаясь
разобраться, почему следующий код ничего не делает:
long x;
x &= 0xffff; // очистить все, кроме младших 16-ти бит
// 32битного
типа long.
Компьютер имел 16-битовый тип int и 32-битовый тип long. Константа
0xffff
типа int с арифметическим значением -1. Компилятор Си при
трансляции &= обнаруживал разные типы операндов и поэтому
преобразовывал int в long. -1 в типе long представляется как
0xffffffff
, поэтому логическая операция И не имела эффекта. Это как
раз тот способ, которым и должен работать данный язык
программирования. Я просто об этом не подумал.
Заметьте, что вы не можете исправить эту ситуацию приведением
типов. Все, что делает следующий код, это заменяет неявное
преобразование типа явным. Но, тем не менее, происходит то же самое:
x &= (long)0xffff;
Единственным методом решения этой проблемы является:
x &= 0xffffUL;
или равноценный ему.
66.1. Рассчитывайте на невозможное
Оператор switch всегда должен иметь предложение с ключевым словом
default
для ситуации по умолчанию, особенно если эта ситуация не
должна возникать:
f( int i ) // переменная i должна иметь значение 1 или 2.
{
switch
( i )
{
case 1: сделать_нечто(); break
;
case 2: сделать_нечто_другое(); break
;
default
:
fprintf(stderr, "
Внутренняя ошибка в f(): неверное
Правила программирования на Си и Си++
значение i (%d)", i );
exit
( -1 );
}
}
То же самое относится к блокам if/else, работающим в манере, схожей
с оператором switch.
В цикле также нужна проверка на невероятное. Следующий фрагмент
работает, даже если i первоначально равно 0 - чего по идее быть не
должно:
f( int i ) // переменная i должна быть положительной
{
while ( --i "= 0 )
сделать_нечто();
}
Конструкция while(--i) менее надежна, так как она дает ужасный сбой
в случае, если i сначала равно 0.
66.2. Всегда проверяйте коды возврата ошибки
Это должно быть очевидно, но комитет ISO/ANSI по Си++ потребовал,
чтобы оператор new вызывал исключение, если он не смог выделить
память, потому что было установлено, что удивительное множество
ошибок во время выполнения в реальных программах вызвано тем, что
люди не потрудились проверить, не возвратил ли new значение NULL.
Мне также довелось видеть множество программ, в которых люди не
позаботились посмотреть, сработала ли функция fopen(), перед тем как
начать пользоваться указателем FILE.
67. Избегайте явно временных переменных
Большинство переменных, используемых лишь один раз, попадают в эту
категорию. Например, вместо:
int x = *p++;
f( x );
должно быть:
f( *p++ );
Редко бывает, что полезна явная временная переменная, если вам нужно
гарантировать порядок вычислений, или если выражение просто такое
длинное, что его невозможно прочитать. В последнем случае имя
переменной даст полезную информацию и, будучи выбрано правильно,
может устранить необходимость в комментарии. Например, вы можете
заменить:
Правила обычного программирования 91
f( Coefficient_of_lift * (0.5 * RHO * square(v)) );
// передать функции f() образующуюся подъемную силу
на:
double lift = Coefficient_of_lift * (0.5 * RHO * square(v));
f( lift );
Это правило не запрещает ни одно из подобных применений, а является,
скорее, вырожденным случаем того, что упомянуто мной вначале.
68. Не нужно магических чисел
В основном тексте вашей программы не должно быть чисел в явном виде.
Используйте перечислитель или константу для того, чтобы дать числу
символическое имя. (Я уже объяснял, почему для этого не очень хорошо
применять #define). Тут есть два преимущества:
+ Символическое имя делает величину самодокументируемой, устраняя
необходимость в комментарии.
+ Если число используется более чем в одном месте, то менять нужно
лишь одно место - определение константы.
Я иногда делаю исключение из этого правила для локальных переменных.
Например, в следующем фрагменте используется магическое число (128):
f()
{
char buf[128]
fgets( buf, sizeof (buf) / sizeof(*buf), stdin );
}
Я использовал sizeof() в вызове fgets(), поэтому изменения размера
массива автоматически отражаются в программе. Добавление
дополнительного идентификатора для хранения размера добавит
излишнюю сложность.
69. Не делайте предположений о размерах
Классической проблемой является код, исходящий из того, что тип int
имеет размер 32 бита. Следующий фрагмент не работает, если у вас 32битный
указатель и 16-битный тип int (что может быть при архитектуре
Intel 80x86):
double a[1000], *p = a;
// ...
dist_from_start_of_array_in_bytes = (int)p - (int)a;
Более трудно уловима такая проблема в Си (но не в Си++):
Правила программирования на Си и Си++
g()
{
doesnt_work( 0 );
}
doesnt_work( char *p )
{
if
( !p ) // вероятно не работает
// ...
}
Компилятор соглашается с этим вызовом, потому что в Си разрешены
ссылки вперед (и не разрешены в Си++, так что там это не проблема). 0
- это тип int, поэтому в стек помещается 16-битовый объект. Но
функция ожидает 32-битный указатель, поэтому она использует 16 бит из
стека и добавляет к ним еще 16 бит всякого мусора для создания 32битного
указателя. Вероятнее всего, что if(!p) даст ложный результат,
так как только 16 бит из 32 будут равны 0.
Традиционное решение состоит в использовании typedef :
typedef int word; // всегда 16 бит
typedef long dword; // всегда 32 бита.
После чего вы можете поменять операторы typedef в новой
операционной среде, чтобы гарантировать, что word по-прежнему имеет
размер 16 бит, а dword - 32 бита. Для 32-разрядной системы
предыдущее может быть переопределено как:
typedef short word; // всегда 16 бит
typedef int dword; // всегда 32 бита.
Другая связанная с размерностью часовая бомба спрятана в том способе,
которым в ANSI Си обеспечивается работа с иностранными языками.
ANSI Си определяет тип wchar_t для работы с расширенными наборами
символов типа Unicode - нового 16-битного многонационального набора
символов. Стандарт ANSI Си также утверждает, что перед строкой с
расширенными символами должен стоять символ L. Microsoft и другие
поставщики компиляторов стараются помочь вам писать переносимые
программы, предусматривая макросы типа:
#ifdef _UNICODE
typedef wchar_t _TCHAR
# define _T(x) L##x
#else
typedef char _TCHAR
# define _T(x) x
#endif
Если константа _UNICODE не определена, то оператор:
Правила обычного программирования 93
_TCHAR *p = _T("
делай_что_нужно");
имеет значение:
char *p = "
делай_что_нужно";
Если константа _UNICODE определена, тот же самый оператор получает
значение:
wchar_t *p = L"
делай_что_нужно";
Пока все хорошо. Вы теперь можете попробовать перенести вашу старую
программу в среду Unicode, просто используя свой редактор для замены
всех экземпляров char на _TCHAR и помещения всех строковых констант
в скобки _T(). Проблема состоит в том, что такой код, как ниже (в
котором все _TCHAR первоначально были типа char), более не работает:
_TCHAR str[4];
// ...
int max_chars = sizeof(str); // предполагает, что тип char
// имеет размер 1 байт
Тип _TCHAR будет иметь размер 2 байта при определенной константе
_UNICODE
, поэтому число символов у вас будет определено в два раза
большим, чем есть на самом деле. Для исправления ситуации вы должны
воспользоваться следующим вариантом:
int max_chars = sizeof(str) / sizeof(*str);
70. Опасайтесь приведения типов (спорные вопросы
Си)
Оператор приведения типов часто понимается неправильно. Приведение
типов не указывает компилятору "считать эту переменную
принадлежащей к этому типу". Оно должно рассматриваться как операция
времени выполнения, которая создает временную переменную типа,
определенного для приведения, затем инициализирует эту временную
переменную от операнда. В Си++, конечно, эта инициализация может
обернуться очень большими накладными расходами, так как возможен
вызов конструктора.
Первое место, где неверное понимание приведения типов может
навлечь на вас неприятности, находится в Си, где не требуются
прототипы функций. Когда компилятор находит вызов функции без
предшествующего прототипа, то полагает, что эта функция возвращает
тип int. В следующем фрагменте не говорится "malloc() на самом
деле возвращает указатель, а не тип int":
int *p = (int *) malloc( sizeof(int) );
Правила программирования на Си и Си++
а, скорее, код говорит "я полагаю, что malloc() возвращает тип int, так
как тут нет предшествующего прототипа, и преобразую этот int в
указатель для присваивания его значения p". Если тип int имеет размер
16 бит, а указатель 32-битовый, то вы теперь в глубокой луже. Вызов
malloc()
может вернуть и 32-битовый указатель, но так как компилятор
полагает, что malloc() возвращает 16-битовый int, то он игнорирует
остальные 16 бит. Затем компилятор обрезает возвращенное значение до
16-бит и преобразует его в 32-битовый тип int принятым у него
способом, обычно заполняя старшие 16 бит нулями. Если указатель
содержал адрес больше, чем 0xffff, что вероятно для большинства
компьютеров, то вы просто теряете старшие биты. Единственным
способом урегулирования этой проблемы является указание для
malloc()
соответствующего прототипа, который подскажет, что
malloc()
возвращает указатель (обычно путем включения файла
"stdlib.h"
).
Следующий проблема состоит в том, что предыдущее приведение типа
может быть вставлено в программу просто для того, чтобы заставить
заткнуться компилятор, который наверняка будет выдавать
предупреждение о несоответствии типов, если оператор приведения
отсутствует. Приведением типов часто злоупотребляют подобным
образом - чтобы заглушить компилятор, вместо того, чтобы в самом
деле обратить внимание на предупреждение. Многие компиляторы,
например, выдают предупреждение о возможном округлении, встретив
следующий код:
f( int x );
// ...
unsigned y;
f( y );
и многие программисты заглушат такой компилятор при помощи
f((int)y)
. Несмотря на это, приведение типа не изменит того факта,
что тип unsigned int может содержать такое значение, которое не
поместится в int со знаком, поэтому результирующий вызов может не
сработать.
Вот сходная проблема, связанная с указателями на
...Поділитися у соцмережах
