Жанр: Учеба
Правила программирования на Си и Си плюс плюс.
...вершенствовалось).
О возможности использования персонального компьютера для
выполнения домашних заданий не было и речи.
На среднем занятии по программированию присутствовало от 40 до 80
человек, и одновременно проводилось шесть и более занятий. Поэтому,
когда на занятии раздавалось задание, то вы хватали бумагу с ним и
буквально опрометью бросались вниз в терминальный зал, где
приковывали себя к компьютеру и начинали яростно программировать до
тех пор, пока не выполняли свое задание. Это могло продолжаться
несколько дней. Если вы отрывались поесть или поспать, то ваш терминал
занимал другой, и у вас появлялась весьма реальная перспектива не
уложиться в срок, отведенный на задание. Некоторые люди все еще
продолжают программировать подобным способом.
Такая обстановка, конечно, не способствовала хорошо продуманному
проектированию программ, поэтому большинство из этих программ были
в четыре раза больше, чем необходимо, и требовали в два раза больше
времени на отладку, чем требовалось. К тому же, количество строк кода,
написанное за час, сокращается пропорционально количеству часов,
которые вы просидели, глядя на экран. (Это иллюзия - думать, что вы
можете достичь большей производительности, работая 12 часов в день
вместо 8).
Однажды, будучи на последнем курсе, я был так расстроен, пытаясь
решить одну проблему, о которую бился головой в течение примерно
четырех часов, что с чувством отвращения завершил сеанс и выскочил на
улицу. Примерно три минуты спустя, когда я спускался по холму за
порцией сосисок, искомое решение неожиданно всплыло в моей голове.
Имена и идент ификат оры 35
Это было настоящим откровением: вы должны расслабиться, чтобы дать
своему мозгу возможность работать. К сожалению, я не смог пробиться
назад к компьютеру, поэтому я так никогда и не исправил свою ошибку,
но, по крайней мере, понял, как должен работать тот процесс.
21. Пишите программу с учетом сопровождения -
вы специалист по сопровождению
Сопровождение начинается немедленно после завершения программы, а
сопровождением на этой стадии обычно занимаетесь вы сами. Это
хорошая мысль - осчастливить сопровождающего программиста.
Поэтому ваша первая забота о том, чтобы программа легко читалась.
Структура и назначение каждой строки должны быть избыточно ясны, и
если это не так, то вам нужно добавить поясняющие комментарии.
Одной из причин того, что поиски математических доказательств
корректности программ остаются донкихотством, заключается в том, что
нет программ без ошибок. Каждая программа не только содержит
ошибки, но и требования к ней меняются, как только программа начинает
эксплуатироваться, и у пользователя появляются потребность в каких-то
новых свойствах, что вызывает появление новых и усовершенствованных
ошибок. Так как ошибки всегда с нами, то мы должны писать нашу
программу так, чтобы их можно было легче искать.
Вы можете переформулировать настоящее правило таким образом: Не
умничайте. Искусный код почти невозможно сопровождать.
21.1. Эффективность - часто просто пугало
Я потратил несколько часов, делая одну подпрограмму более
"эффективной", и не останавливался, чтобы подумать о том, как часто эта
подпрограмма будет вызываться, что является пустой потерей времени в
том случае, когда программа вызывается лишь один или два раза. Ваша
программа должна быть непременно настолько эффективной, насколько
это возможно, но вашей первоочередной заботой является
сопровождение, и вы не должны приносить читаемость в жертву на алтарь
эффективности. Напишите программу сперва с учетом сопровождения,
затем запустите свою программу под профайлером и определите, где на
самом деле есть узкие места. Будучи вооружены реальной информацией,
вы теперь знаете, где стоит обменять часть читаемости на скорость, и
можете вернуться и сделать это изменение. Тем не менее, вы можете
включить первоначальный текст в комментарий, чтобы не потерять его.
Всегда имейте в виду, что любое количество подчисток на уровне текста
Правила программирования на Си и Си++
36
программы не повысит эффективность так, как это сделает лучший
алгоритм. Пузырьковая сортировка будет выполняться медленно вне
зависимости от того, насколько хорошо она запрограммирована.
Часть
Форматирование и документация
Форматирование важно; тексты на Си и Си++ и так достаточно тяжело
читаются, чтобы ухудшать ситуацию еще и плохим форматированием.
Представьте, что вы пытаетесь прочесть книгу, текст которой не
отформатирован: нет абзацных отступов, разделения абзацев пустой
строкой, пробелов после знаков препинания и так далее. Сопровождение
плохо отформатированной программы невозможно.
Я объединил правила форматирования и документации в одной части,
потому что форматирование является одним из лучших инструментов
документирования, имеющихся в вашем распоряжении. Под
"документацией", рассматривающейся в этой части книги, понимается
документирование программ (т.е. комментарии, а не документация уровня
пользователя). Его зря не относят к программированию, ведь хороший
комментарий для вас - в буквальном смысле нить Ариадны.
Я сознаю, что дискуссии по вопросам форматирования и документации
часто достигают религиозного накала. Имейте в виду, что приводимые
здесь мной правила - только те, которыми я пользуюсь сам. Имеются и
другие совершенно разумные методы работы. С другой стороны, кто-то
не особо умный мне однажды сказал, что "не важно, какой стиль
форматирования вы применяете, если вы применяете его постоянно".
Программа, которая постоянно форматируется плохо, хуже, чем понятная
временами. Случайный просвет лучше, чем никакого.
Правила программирования на Си и Си++
22. Программа без комментариев ничего не стоит
Программа, на написание которой затрачен год, может использоваться в
течение 10 лет. Вам придется затратить на сопровождение гораздо больше
денег, чем вы выделили на первоначальную разработку, а программа без
комментариев несопровождаема. "Блестящий" программист, который
втрое быстрее, чем другие, пишет короткий, элегантный, но
некомментированный текст программы, вам обойдется дорого. Какому-то
менее талантливому программисту придется затратить в 10 раз больше
времени, чем нужно, устраняя неизбежные ошибки.
Программисты, которые не могут писать по-английски (или на том
языке, на котором говорят в стране, где предполагается осуществлять
сопровождение), изготовляют часовые бомбы, а не компьютерные
программы. Так как хорошая документация столь необходима для
процесса сопровождения, то важно, чтобы программисты были способны
ее написать. По этой причине начинающие программисты, имеющие
диплом по филологии, истории или другой гуманитарной дисциплине,
часто являются более предпочтительными, чем люди с дипломами по
естественным наукам (математике, физике и т.п.). Специалисты по
естественным наукам редко знают как писать, а большинство из них
также не знают как программировать; они обучены тому, как
запрограммировать алгоритм, а не как написать пригодную для
сопровождения компьютерную программу.
К счастью, писать можно легко научиться. Конечно, если вы
придерживаетесь правила "Сделай сначала комментарии", то вам
придется писать все свои комментарии до начала программирования.
23. Располагайте программу и документацию вместе
Если документация отделена от текста программы, то ее очень трудно
обновлять. Следовательно, основная часть вашей документации должна
располагаться в комментариях, а не в отдельном документе.
Если вам на самом деле нужна отпечатанная документация высшего
качества, то вы можете воспользоваться чем-нибудь похожим на систему
Web (для языка Паскаль) или CWeb (для языков Си и Си++) в комбинации
с TEX1. Я пользуюсь подобной системой под названием arachne, которая
1 Web описана в книге Дональда Кнута ""The WEB System of Structured
Documentation" (Palo Alto: Stanford University Dept. of Computer Science, Report
No.STAN-CS-83-980, 1983). Система CWeb описана в книге Дональда Е. Кнута и
Сильвио Ливая "The CWeb System of Structured Documentation" (Reading: Addison
Wesley, 1994). Обе публикации не только описывают как работают эти системы, но
Формат ирование и документ ация 39
была разработана мной для того, чтобы писать свою книгу "Compiler
Design in C". (Arachne документирует тексты на Си и Си++, используя в
качестве редактора troff). Все эти программы позволяют вам размещать
исходный текст программы и документацию в одном файле. Вы можете
выделить исходный текст для компиляции, или загрузить этот файл в
текстовый процессор, чтобы напечатать единое руководство с исходным
текстом и документацией. Эти системы позволяют осуществлять
перекрестный поиск идентификаторов в программе и документации,
позволяя вам прослеживать связи одной части программы с другой ("этот
код используется вон там"), и так далее. Так как для получения печатной
версии используется обычный текстовый процессор, то вы можете делать
то, чего непросто добиться в комментариях - вставлять рисунки,
например.
24. Комментарии должны быть предложениями
Они должны быть хорошо составлены и иметь правильную пунктуацию,
по возможности без сокращений. Не превращайте свои комментарии в
секретный код, применяя странные сокращения и изобретая свой
собственный грамматический строй. Вам также не должна требоваться
нить Ариадны для расшифровки комментариев.
25. Пропустите свой исходный тест через систему
проверки орфографии
Ваши комментарии не только станут более читаемыми, этот метод
побудит вас использовать в качестве имен переменных те, что легко
читаются, т. к. являются обычными словами.
26. Комментарий не должен подтверждать
очевидное
Начинающие программировать на Си склонны попадать в эту ловушку.
Избегайте явно нелепых случаев типа:
++x; // увеличить x
но мне также не нравятся комментарии типа:
хорошо демонстрируют это. В этих книгах документируются реальные тексты
программ, реализующих указанные системы.
TEX является редакционно-издательской системой Кнута. Она имеется в
нескольких коммерческих версиях.
Правила программирования на Си и Си++
/*-------------------------------------------
* Определения глобальных переменных:
*-------------------------------------------
*/
Любой средний программист знает, как выглядит определение.
27. Комментарий должен предоставлять только
нужную для сопровождения информацию
Особенно неприятным и бесполезным комментарием является
декларативный заголовочный блок. Заголовок сам по себе не является
злом, а совсем наоборот. Блок комментариев в начале файла,
описывающий, что делается в файле, может быть довольно полезен.
Хороший блок говорит вам, какое свойство реализуется файлом,
показывает список открытых (не статических) функций, сообщает вам,
что эти функции делают и т.д.
Заголовки, которые мне не нравятся, имеют содержание, которое
определяется указанием, обычно типа какого-то руководства по
фирменному стилю. Такие заголовки обычно выглядят подобно листингу
1, увеличивая беспорядок посредством обильных количеств бесполезной
информации за счет читаемости. Часто случается так, как на листинге 1,
когда заголовок существенно больше самой программы. Также обычно,
как в нашем случае, что текст программы или совершенно
самодокументирован, или нужно добавить одну или две строки
комментариев, чтобы он им стал. Хотя требование вышеуказанной
бессмыслицы и может согревать душу деспота-руководителя, но для
облегчения сопровождения оно мало что дает.
Листинг 1. Бесполезный заголовочный комментарий
1 /*------------------------------------------------------**
2 ** **
3 ** ДАТА: 29 февраля 2000 г. **
4 ** ФУНКЦИЯ: **
5 ** equal **
6 ** **
7 ** АВТОР: **
8 ** Джозеф Эндрюс **
9 ** **
10 ** ОПИСАНИЕ: **
11 ** Эта функция предназначена для сравнения двух строк **
12 ** на лексикографическое равенство. **
13 ** **
14 ** ИСКЛЮЧЕНИЯ: **
15 ** Функция не работает для строк Unicode. **
16 ** **
Формат ирование и документ ация 41
17 ** СПЕЦИАЛЬНЫЕ ТРЕБОВАНИЯ: **
18 ** нет. **
19 ** **
20 ** АРГУМЕНТЫ: **
21 ** char *s1; Указатель на первую сравниваемую строку **
22 ** char *s2; Указатель на вторую сравниваемую строку **
23 ** **
24 ** РЕЗУЛЬТАТЫ: **
25 ** Функция возвращает true, если строки-аргументы **
26 ** лексикографически идентичны. **
27 ** **
28 ** КОММЕНТАРИИ: **
29 ** нет. **
30 ** **
31 ** ПРИМЕЧАНИЯ ПО РЕАЛИЗАЦИИ: **
32 ** нет. **
33 ** **
34 ** ИСТОРИЯ ИЗМЕНЕНИЙ: **
35 ** **
36 ** АВТОР: Эндрюс, Джозеф **
37 ** ДАТА: 12, июль, 1743 **
38 ** ИЗМЕНЕНИЕ: Начальное состояние **
39 ** **
40 ** АВТОР: Джонс, Том **
41 ** ДАТА: 13, июль, 1743 **
42 ** ИЗМЕНЕНИЕ: Изменены имена аргументов со str1, str2. **
43 ** **
44 ** Вест текст программы в этом файле охраняется **
45 ** авторским правом. **
46 ** Copyright © Вымышленная корпорация **
47 ** Все права сохраняются. **
48 ** **
49 ** Никакая часть этой подпрограммы не может быть **
50 ** воспроизведена в любой форме без явного разрешения **
51 ** в трех экземплярах со стороны отдела Министерства **
52 ** сокращения персонала. Нарушители будут лишены своего **
53 ** старшего сына. **
54 **------------------------------------------------------**
55 */
56 inline equal ( char *s1, char *s2 )
57 {
58 return !strcmp( s1, s2 ); // Возвращает истину, если
59 } // строки равны.
Действительная проблема заключается в том, что этот тип заголовков
нарушает ряд других правил, таких как: "не комментируй очевидное",
"исключай неразбериху" и так далее. Тот минимум реальной информации,
который содержится в этом заголовке, относится к системе регистрации
изменений, а не к исходному тексту программы. Комментарии в
программе должны сообщать вам сведения, полезные при
сопровождении.
Правила программирования на Си и Си++
28. Комментарии должны быть в блоках
Комментарии в общем воспринимаются лучше, когда помещаются в
многострочных блоках, которые чередуются с блоками текста
программы. Для этого комментарий должен описывать на высоком
уровне, что делают несколько последующих строк кода. Если
комментарии попадаются через строчку, то это похоже на чтение двух
книг одновременно, причем по строке из каждой по очереди. И если
программа, комментируемая вами, сложная, то вы можете
воспользоваться сносками:
// Вот блочный комментарий, описывающий последующий блок
// программы. После общего резюме я описываю некоторые
// особенности:
//
// 1. Этот комментарий описывает, что происходит в строке
// с меткой 1
//
// 2. Этот комментарий описывает, что происходит в строке
// с меткой 2
//
// В точке 1 алгоритм устанавливается на ...
//
here_is_the_code();
while
( some_condition )
{
this_code_is_rather_obscure(); /* 1 */
}
more_stuff_here();
while
( some_condition )
{
this_code_is_also_obscure(); /* 2 */
}
29. Комментарии должны быть выровнены
вертикально
Выравнивайте начало и конец комментария вертикально в многострочных
комментариях.
/* Первая строка,
* вторая строка,
* третья строка.
*/
Если ваш компилятор их поддерживает, то здесь помогут комментарии в
стиле Си++:
Формат ирование и документ ация 43
// Первая строка,
// вторая строка,
// третья строка.
Есть две причины появления этого правила, они обе демонстрируются в
последующей программе:
/**********************************************************
void the_function( void )
Это многострочный комментарий, выполняющий все, что должен
делать комментарий.
К сожалению, отсутствие слева вертикального столбца из
звездочек затрудняет зрительное разделение комментария и
программы
***********************************************************
void the_function( void )
{
// далее настоящая функция.
code_goes_here();
}
/**********************************************************/
Во-первых, заметили ли вы, что я забыл поместить / в конце второй
строки звездочек? Таким путем можно запросто терять целые функции.
Во-вторых, трудно заметить, где оканчивается комментарий и начинается
текст программы. Исправьте обе ошибки следующим образом:
/***********************************************************
* void the_function( void )
*
* Это многострочный комментарий, выполняющий все, что должен
* делать комментарий.
*
* Вертикальный столбец из звездочек слева облегчает
* зрительное разделение комментария и программы
***********************************************************
*/
void the_function( void )
{
// далее настоящая функция.
code_goes_here();
}
Правила программирования на Си и Си++
30. Используйте аккуратные столбцы везде, где
можно
Так как форматирование по сути является видом комментирования, то это
правило применяйте также и к тексту программы. Два следующих блока
функционально одинаковы, но заметьте, насколько легче искать имена
переменных во втором блоке, причем не из-за выравнивания
комментариев, а потому что имена образовали аккуратный столбец:
int x; // Опишите, что делает x.
unsigned long int (*pfi)(); // Опишите, что делает pfi.
const char *the_variable; // Опишите, что делает the_variable.
int z; // Опишите, что делает z.
x = 10; // Здесь идет комментарий.
the_variable = x; // Здесь второй комментарий.
z = x; // A здесь третий.
по сравнению с:
int x; // Опишите, что делает x.
unsigned long int ( *pfi )(); // Опишите, что делает pfi.
int z; // Опишите, что делает z.
const char *the_variable; // Опишите, что делает
// the_variable.
x = 10; // Здесь идет комментарий.
the_variable = x; // Здесь второй комментарий.
z = x; // A здесь третий.
Вы можете рассматривать на этот вид форматирования как по сути
"табличный", как если бы я создал таблицу со столбцами "тип", "имя" и
"описание".
Другим хорошим местом для использования столбцов является список
инициализации элементов в Си++, который я форматирую следующим
образом:
class derived : public base
{
string str;
const int x;
public:
derived( char *init_str, int init_x ) {}
}
derived::derived( char *init_str, int init_x )
:base( str, x )
,str ( init_str )
,x ( init_x )
{}
Формат ирование и документ ация 45
31. Не располагайте комментариев между именем
функции и открывающей скобкой
Основная сложность в следующем примере:
foo( int x )
/* Не помещайте
* комментарий
* здесь. */
{
//...
}
заключается в том, что тело функции может оканчиваться на следующей
странице или не помещаться на одном экране. То есть читающий не
может сказать, видит ли он прототип или действительное определение.
Поместите этот комментарий или до имени функции, или вставьте его в
тело функции ниже открывающей скобки:
/* Или помещайте
** его здесь.
*/
foo( int x )
{
/* или здесь,
** с таким же отступом, что и у кода.
*/
}
32. Помечайте конец длинного составного оператора
чем-нибудь, имеющим смысл
Прежде всего, подобные комментарии в конце блока:
while
( a " b )
{
for
( i = 10; --1 "= 0; )
{
f( i );
} // for
} // while
не дают ничего, кроме неразберихи, если блоки короткие. Я использую их
только тогда, когда составной оператор слишком велик, чтобы
поместиться на экран (в моем текстовом редакторе около 40 строк) или в
нем столько уровней вложений, что я не могу понять суть происходящего.
Комментарии в конце блока обычно целесообразны в больших составных
операторах, но мне приходилось часто видеть подобный код:
Правила программирования на Си и Си++
На первой странице:
while
( a " b )
{
while
( something_else() )
{
for
( i = 10; --1 "= 0; )
{
for
( j = 10; --j "= 0; )
{
// далее идет масса кода
На какой-то из последующих страниц:
} // for
} // for
} // while
} // while
Эти комментарии слишком кратки, чтобы быть полезными. Завершающие
блок комментарии должны полностью описывать управляющий оператор.
Завершающие блок комментарии из предыдущего примера должны
выглядеть таким образом:
} // for( j = 10; --j "= 0; )
} // for( i = 10; --1 "= 0; )
} // while( something_else() )
} // while( a " b )
Так как #ifdef почти всегда расположен на некотором расстоянии от
#endif
, то я всегда ставлю метку у #endif:
#ifndef __SOMEFILE_H_
#define __SOMEFILE_H_
// здесь следует 1000 строк программы
#endif // __SOMEFILE_H_
То же самое я делаю с #else.
33. Располагайте в строке только один оператор
Нет абсолютно никакой причины упаковывать в одну строку столько
операторов, сколько сможете, если только у вас нет намерения сделать
программу нечитаемой. Если в строке больше одной точки с запятой, то
что-то неверно. Не используйте запятую-оператор (даже если вы знаете,
что это такое) по той же причине. Очевидным исключением является
оператор for, все три части которого должны быть на одной строке.
Формат ирование и документ ация 47
34. Указывайте имена аргументов в прототипах
функций
Это особенно важно в определениях классов. Страницы руководств (и
встроенных систем помощи) для программы, над которой вы старательно
работаете, вряд ли существуют в тот момент, когда они вам нужны
больше всего - когда вы начинаете разработку. Вы обычно получаете
документацию из двух мест: комментариев, добавленных к настоящим
функциям и заголовочных файлов. Из них обычно лучше заголовочный
файл, как более компактный. В любом случае из документации, которая
на самом деле нужна по функции, вам необходимо знат
...Поділитися у соцмережах
