Главная - Литература

0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 [238] 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294

31.2. Способы форматирования

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

Неотображаемые символы

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

Перекрешаи сшдка Некото Р придет в голову писать книгу без пробелов между

рышпщттт \pmmr словами, разбиения на абзацы и деления на главы. Может, аналогий между структурой такую книгу и можно прочитать от начала до конца, но прак-кнйги и структурой программы тически невозможно просматривать ее в поисках какой-то (см. подраздел «Книжная пара- мысли или важного эпизода. Еще хуже, что такой формат дигма документирования про- уу не позволит показать читателю, как автор намеревал-грамм» раздела 32.5). ,

ся организовать информацию. Структура, предлагаемая автором, дает подсказку о логической организации темы.

Разбиение книги на главы, абзацы и предложения показывает читателю, как следует мысленно организовывать тему. Если эта организация неочевидна, читателю приходится самому ее домысливать, что налагает на него более тяжкое бремя и увеличивает вероятность никогда не узнать, как на самом деле организована данная тема.

Информация, содержащаяся в программе, сосредоточена еще плотней, чем информация в большинстве книг. Если страницу книги можно прочесть и понять за 1 или 2 минуты, то большинство программистов не могут читать и понимать листинг программы со скоростью, даже приблизительно сравнимой с этой. Программа должна давать гораздо больше подсказок о своей организации, чем книга.

Группировка Еще один способ применения неотображаемых символов - группировка взаимосвязанных выражений

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

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

Пустые строки позволяют продемонстрировать организацию программы. Вы можете использовать их для деления групп взаимосвязанных операторов на абзацы, отделения методов друг от друга и выделения комментариев.

Хотя эту статистику тяжело применить на практике, но одно исследова-ние показало, что оптимальное число пустых строк в программе составляет от 8% до 16%. Если оно больше 16%, то время, затрачиваемое на отладку, заметно увеличивается (Gorla, Benander and Benander, 1990).



Отступы Применяйте отступы для демонстрации логической структуры программы. Как правило, операторы выделяются отступами, когда они следуют после некоторого выражения, от которого они логически зависят.

Существуют данные, что отступы влияют на способность программиста jjff 1 понимать код. В статье «Program Indentation and Comprehensibility» сообщается, что некоторые исследования выявили корреляцию между на-

личием отступов и способностью к пониманию кода (Miaria et al., 1983). В тесте на понимание испытуемые показали результат на 20-30% лучше, когда программы использовали схему отступов из 2-4-х пробелов, чем когда программы вообще не содержали отступов.

То же исследование выявило, что нельзя не только недостаточно выде-Jlnt лять, но и чрезмерно подчеркивать логическую структуру программы.

Меньше всего баллов за понимание получили программы, совсем не содержащие отступов. Второй с конца результат принадлежал программам, использующим отступы из 6 пробелов. Авторы пришли к выводу, что оптимальными являются отступы из 2-4-х пробелов. Интересно, что многим испытуемым отступы из 6 пробелов показались удобнее, чем другие, даже несмотря на то, что окончательный результат оказался хуже. Возможно, это связано с тем, что отступы из 6 пробелов выглядят приятнее. Но независимо от того, насколько красиво они выглядят, отступы из 6 пробелов оказались хуже читаемыми. Это один из примеров коллизии между эстетикой и читабельностью.

Скобки

Используйте скобки чаще, чем вам это кажется необходимым. Применяйте скобки для разъяснения выражений, состоящих из двух и более членов. Возможно, в скобках нет нужды, но они добавляют ясности и ничего вам не стоят. Например, скажите, как вычисляются следующие выражения?

Вариант на С++: 12 + 4% 3 * 7 / 8

Вариант на Microsoft Visual Basic: 12 + 4 mod 3 * 7 / 8

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

31.3. Стили форматирования

Большинство вопросов форматирования касается размещения блоков - групп операторов, располагающихся под управляющими выражениями. Блок окружен скобками или ключевыми словами: / и } в С++ и Java, if-then-endif ъ Visual Basic и другими похожими структурами в других языках. Для простоты в большей части этого обсуждения используются общие обозначения begin и end. Я предполагаю, что вы поймете, как это можно соотнести со скобками в С++ и Java или аналогичными механизмами выделения блоков в других языках. Ниже описаны четыре основных стиля форматирования:



явные блоки;

эмуляция явных блоков;

использование пар begin-end (скобок) для обозначения границ блока;

форматирование в конце строки.

Явные блоки

Большинство споров по поводу форматирования возникает из-за несовершенства большинства популярных языков программирования. Хорошо спроектированный язык имеет явную структуру блоков, которая приводит к естественному стилю отступов. Так, в Visual Basic у каждой управляющей структуры есть свой терминатор, и вы не сможете ее использовать без этого терминатора. Код разбивается на блоки естественным образом. Несколько примеров на Visual Basic приведено в листингах 31-6, 31-7 и 31-8:

Листинг 31-6. Пример явного блока (Visual Basic)

If pixelColor = Color Recl Then statementi statement2

End If

Листинг 31-7. Пример явного блока while (Visual Basic)

While pixelColor = Color Recl statementi statement2

Wend

Листинг 31-8. Пример явного блока case (Visual Basic)

Select Case pixelColor Case Color Red statementi statement2

Case Color Green statementi statement2

Case Else statementi statement2

End Select

Управляющая структура на Visual Basic всегда состоит из начального выражения (в этих примерах - If-Then, While и Select-Case) и всегда содержит соответствую-



0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 [238] 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294



0.0024