Голуб Ален И. - Веревка достаточной длины, чтобы... выстрелить с. Руководство по программированию. Автору удается сделать изложение столь серьезной темы живым и интересным за счет рассыпанного по тексту юмора и глубокого знания предмета
 Скачать 1.36 Mb.
|
|
В ЕРЕВКА ДОСТАТОЧНОЙ ДЛИНЫ, ЧТОБЫ… ВЫСТРЕЛИТЬ СЕБЕ В НОГУ Правила программирования на Си и Си++ Ален И. Голуб Москва 2001 Программисты, инженеры, научные работники, студенты и все, кто работает с Си или Си++! Если вы хотите писать лучший код без блужданий по лабиринтам технической документации, то это краткое, но содержательное руководство является именно тем, что вам нужно. "Веревка достаточной длины, чтобы… выстрелить себе в ногу" предлагает более 100 практических правил, которые вы сможете использовать для создания элегантного, простого в сопровождении кода. А так как книга написана признанным знатоком в этой области, то è вы в ней не заблудитесь. Ален Голуб предлагает необходимый набор пояснений, советов и технических приемов с целью помочь вам полностью использовать возможности этих чрезвычайно мощных языков. Но не бойтесь встретить очередное скучное руководство по программированию. Автору удается сделать изложение столь серьезной темы живым и интересным за счет рассыпанного по тексту юмора и глубокого знания предмета. Голуб рассматривает универсальные правила, форматирование и правильную организацию программ перед тем, как углубиться в такие основополагающие вопросы, как: ♦ Практические способы организации и написания сопровождаемого кода. ♦ Объектно-ориентированное программирование и методы абстракции данных. ♦ Как избежать проблем, специфических для Си и Си++. Для закрепления правил, намеченных в этой книге в общих чертах, предлагается множество примеров. Вы также найдете здесь полезные проектные стратегии, освещение вопросов административного управления и многое другое. © Original copyright. McGraw–Hill, 1995 © Перевод с английского языка. В.Зацепин, 1996 © Редакция и текст примечаний. В.Базаров, 1998 © Оформление Интернет–версии. В.Зацепин, 2001 Посвящается Аманде Содержание БЛАГОДАРНОСТИ.........................................................................................................10 ВВЕДЕНИЕ ...................................................................................................................... 11 Часть 1. ПРОЦЕСС ПРОЕКТИРОВАНИЯ................................................................ 14 1. Сущность программирования: без сюрпризов, минимум сцепления и максимум согласованности................................................................................... 15 2. Подавляйте демонов сложности (часть 1) ........................................................... 16 2.1. Не решайте проблем, которых не существует......................................................16 2.2. Решайте конкретную проблему, а не общий случай........................................... 16 3. Интерфейс пользователя не должен быть похожим на компьютерную программу (принцип прозрачности) .................................................................... 18 4. Не путайте легкость в изучении с легкостью в использовании ......................... 21 5. Производительность может измеряться числом нажатий клавиш .................... 22 6. Если вы не можете сказать это по-английски, то вы не сможете выполнить это и на Си/Си++.................................................................................................... 22 6.1. Начинайте с комментариев.................................................................................... 24 7. Читайте код............................................................................................................. 24 7.1. В цехе современных программистов нет места примадоннам .......................... 25 8. Разбивайте сложные проблемы на задачи меньшего размера ........................... 25 9. Используйте весь язык........................................................................................... 25 9.1. Используйте для работы соответствующий инструмент.................................... 25 10. Проблема должна быть хорошо продумана перед тем, как она сможет быть решена..................................................................................................................... 26 11. Компьютерное программирование является индустрией обслуживания ......... 27 12. Вовлекайте пользователей в процесс проектирования....................................... 28 13. Заказчик всегда прав .............................................................................................. 28 14. Малое — это прекрасно (большое == медленное).............................................. 29 Часть 2. ОБЩИЕ ПРОБЛЕМЫ РАЗРАБОТКИ ПРОГРАММ............................... 31 15. Прежде всего, не навреди...................................................................................... 32 16. Редактируйте свою программу ............................................................................. 32 17. Программа должна быть переписана не менее двух раз .................................... 32 18. Нельзя измерять свою производительность числом строк ................................ 32 19. Вы не можете программировать в изоляции ....................................................... 33 20. Пустые потери времени ......................................................................................... 34 21. Пишите программу с учетом сопровождения — вы специалист по сопровождению...................................................................................................... 35 21.1. Эффективность — часто просто пугало............................................................. 35 Часть 3. ФОРМАТИРОВАНИЕ И ДОКУМЕНТАЦИЯ........................................... 37 22. Программа без комментариев ничего не стоит ................................................... 38 23. Располагайте программу и документацию вместе.............................................. 38 24. Комментарии должны быть предложениями ...................................................... 39 25. Пропустите свой исходный тест через систему проверки орфографии............ 39 Содержание 5 26. Комментарий не должен подтверждать очевидное ............................................. 39 27. Комментарий должен предоставлять только нужную для сопровождения информацию ........................................................................................................... 40 29. Комментарии должны быть выровнены вертикально......................................... 42 30. Используйте аккуратные столбцы везде, где можно........................................... 44 31. Не располагайте комментариев между именем функции и открывающей скобкой .................................................................................................................... 45 32. Помечайте конец длинного составного оператора чем-нибудь, имеющим смысл ....................................................................................................................... 45 33. Располагайте в строке только один оператор ...................................................... 46 34. Указывайте имена аргументов в прототипах функций....................................... 47 35. Используйте "предикатную" форму при разбиении длинных выражений ....... 47 36. Подпрограмма должна помещаться на экране..................................................... 48 37. Нужно обеспечивать возможность распечатки всего текста программы.......... 48 38. Используйте штриховую линию для зрительного разделения подпрограмм ... 49 39. Пробел — один из наиболее эффективных комментариев................................. 50 40. Используйте отступы в четыре пробела............................................................... 51 41. Условные операторы выделяются абзацными отступами .................................. 52 41.1. Комментарии должны иметь тот же отступ, что и окружающий текст программы............................................................................................................... 53 42. Выравнивайте скобки вертикально по левой границе ........................................ 54 43. Используйте скобки, если в условном операторе имеется более, чем одна строка....................................................................................................................... 54 Часть 4. ИМЕНА И ИДЕНТИФИКАТОРЫ ............................................................... 56 44. Имена должны быть обычными словами английского языка, описывающими то, что делает функция, аргумент или переменная ................. 57 44.1. Не используйте в качестве имен тарабарщину .................................................. 58 45. Имена макросов должны записываться ЗАГЛАВНЫМИ_БУКВАМИ ............. 59 45.1. Не используйте заглавных букв для констант перечисления........................... 59 45.2. Не используйте заглавных букв в именах типов, созданных при помощи typedef ................................................................................................................. 59 46. Не пользуйтесь именами из стандарта ANSI Cи ................................................. 60 47. Не пользуйтесь именами Microsoft ....................................................................... 60 48. Избегайте ненужных идентификаторов ............................................................... 62 49. Именованные константы для булевых величин редко необходимы.................. 62 Часть 5. ПРАВИЛА ОБЫЧНОГО ПРОГРАММИРОВАНИЯ................................ 66 50. Не путайте привычность с читаемостью .............................................................. 67 51. Функция должна делать только одно дело........................................................... 69 52. Иметь слишком много уровней абстракции или инкапсуляции так же плохо, как и слишком мало ................................................................................... 69 53. Функция должна вызываться более одного раза, но… ....................................... 70 53.1. Код, используемый более одного раза, должен быть помещен в функцию.... 71 54. Функция должна иметь лишь одну точку выхода ............................................... 71 54.1. Всегда предусматривайте возврат значения из блока внешнего уровня......... 72 55. Избегайте дублирования усилий........................................................................... 73 56. Не захламляйте область глобальных имен........................................................... 74 Правила программирования на Си и Си++ 6 56.1. Избегайте глобальных идентификаторов........................................................... 74 56.2. Никогда не требуйте инициализации глобальной переменной при вызове функции .................................................................................................................. 75 56.2.1. Делайте локальные переменные статическими в рекурсивных функциях, если их значения не участвуют в рекурсивном вызове...................................... 76 56.3. Используйте счетчик экземпляров объектов вместо инициализирующих функций .................................................................................................................. 77 56.4. Если оператор if завершается оператором return, то не используйте else........................................................................................................................ 78 57. Помещайте более короткий блок условного оператора if/else первым...... 80 58. Старайтесь сдвинуть ошибки с этапа выполнения на этап компиляции .......... 80 59. Применяйте указатели на функции Си в качестве селекторов .......................... 82 60. Избегайте циклов do/while ............................................................................... 83 60.1. Никогда не используйте do/while для бесконечного цикла......................... 84 61. В цикле со счетчиком его значение должно по возможности уменьшаться .... 84 62. Не делайте одно и то же двумя способами одновременно................................. 84 63. Используйте оператор for, если имеются любые два из инициализурующего, условного или инкрементирующего выражений........... 85 64. То, чего нет в условном выражении, не должно появляться и в других частях оператора for............................................................................................ 87 65. Допускайте, что ситуация может измениться в худшую сторону ..................... 87 66. Компьютеры не знают математики ...................................................................... 88 66.1. Рассчитывайте на невозможное .......................................................................... 89 66.2. Всегда проверяйте коды возврата ошибки ........................................................ 90 67. Избегайте явно временных переменных.............................................................. 90 68. Не нужно магических чисел.................................................................................. 91 69. Не делайте предположений о размерах................................................................ 91 70. Опасайтесь приведения типов (спорные вопросы Си) ....................................... 93 71. Немедленно обрабатывайте особые случаи......................................................... 95 72. Не старайтесь порадовать lint ............................................................................... 97 73. Помещайте код, динамически распределяющий и освобождающий память, в одном и том же месте............................................................................ 98 74. Динамическая память — дорогое удовольствие ................................................. 99 75. Тестовые подпрограммы не должны быть интерактивными ........................... 100 76. Сообщение об ошибке должно подсказывать пользователю, как ее исправить .............................................................................................................. 101 77. Не выводите сообщения об ошибке, если она исправима................................ 102 78. Не используйте системно-зависимых функций для сообщений об ошибках. 102 Часть 6. ПРЕПРОЦЕССОР ......................................................................................... 104 79. Все из одного .h файла должно быть использовано в, по меньшей мере, двух .c файлах..................................................................................................... 105 80. Используйте вложенные директивы #include ............................................. 105 81. Вы должны быть всегда способны заменить макрос функцией ...................... 106 81.1. Операция ?: не то же самое, что и оператор if/else ................................ 111 81.2. Помещайте тело макроса и его аргументы в круглые скобки........................ 112 82. enum и const лучше, чем макрос ..................................................................... 113 Содержание 7 83. Аргумент параметризированного макроса не должен появляться в правой части более одного раза ....................................................................................... 114 83.1. Никогда не используйте макросы для символьных констант ........................ 115 84. Если все альтернативы отпали, то используйте препроцессор ........................ 116 Часть 7 . ПРАВИЛА, ОТНОСЯЩИЕСЯ К ЯЗЫКУ СИ ........................................ 119 85. Подавляйте демонов сложности (часть 2).......................................................... 120 85.1. Устраняйте беспорядок...................................................................................... 120 85.2. Избегайте битовых масок; используйте битовые поля ................................... 121 85.3. Не используйте флагов завершения.................................................................. 123 85.4. Рассчитывайте, что ваш читатель знает Си...................................................... 124 85.5. Не делайте вид, что Си поддерживает булевый тип (#define TRUE) . 124 86. Для битового поля размером 1 бит должен быть определен тип unsigned. 126 87. Указатели должны указывать на адрес, больший, чем базовый для массива. 126 88. Используйте указатели вместо индексов массива............................................. 127 89. Избегайте goto, за исключением…................................................................... 128 Часть 8. ПРАВИЛА ПРОГРАММИРОВАНИЯ НА СИ++..................................... 132 Часть 8а. ВОПРОСЫ ПРОЕКТИРОВАНИЯ И РЕАЛИЗАЦИИ.......................... 133 90. Не смешивайте объектно-ориентированное и "структурное" проектирование .................................................................................................... 133 90.1. Если проект не ориетирован на объекты, то используйте Си ........................ 133 91. Рассчитывайте потратить больше времени на проектирование и меньше на разработку ........................................................................................................ 135 92. Библиотеки классов Си++ обычно не могут быть использованы неискушенными пользователями........................................................................ 136 93. Пользуйтесь контрольными таблицами ............................................................. 137 94. Сообщения должны выражать возможности, а не запрашивать информацию ......................................................................................................... 139 95. Вам обычно не удастся переделать имеющуюся структурную программу в объектно-ориентированную ............................................................................. 139 96. Объект производного класса является объектом базового класса................... 141 97. Наследование — это процесс добавления полей данных и методов-членов .. 141 98. Сначала проектируйте объекты........................................................................... 144 99. Затем проектируйте иерархию снизу вверх ....................................................... 144 99.1. Базовые классы должны иметь более одного производного объекта............ 145 100. Возможности, определенные в базовом классе, должны использоваться всеми производными классами ........................................................................... 145 101. Си++ — это не Smalltalk: избегайте общего класса object .......................... 145 102. Смешения не должны наследоваться от чего попало ...................................... 151 103. Смешения должны быть виртуальными базовыми классами.......................... 151 104. Инициализируйте виртуальные базовые классы при помощи конструктора, используемого по умолчанию .................................................... 151 105. Наследование не подходит, если вы никогда не посылаете сообщения базового класса объекту производного класса .................................................. 152 106. Везде, где можно, предпочитайте включение наследованию ......................... 152 107. Используйте закрытые базовые классы лишь когда вы должны обеспечить виртуальные замещения .................................................................. 152 Правила программирования на Си и Си++ 8 108. Проектируйте структуры данных в последнюю очередь ................................ 153 109. Все данные в определении класса должны быть закрытыми.......................... 154 110. Никогда не допускайте открытого доступа к закрытым данным ................... 154 110.1. Не пользуйтесь функциями типа get/set (чтения и присваивания значений) .............................................................................................................. 158 111. Откажитесь от выражений языка Си, когда программируете на Си++.......... 160 112. Проектируйте с учетом наследования............................................................... 161 112.1. Функция-член должна обычно использовать закрытые поля данных класса .................................................................................................................... 162 113. Используйте константы ...................................................................................... 163 114. Используйте структуры только тогда, когда все данные открытые и нет функций-членов ................................................................................................... 164 115. Не размещайте тела функций в определениях классов ................................... 165 116. Избегайте перегрузки функций и аргументов, используемых по умолчанию............................................................................................................ 169 |