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

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

Избегайте отсутствия отступов в парах begin-end В стиле форматирования, проиллюстрированном в листинге 31-24, пара begin-end выровнена по границе управляющей структуры, а в выражениях, охватываемых операторами begin и end, сделаны отступы относительно begin.

Листинг 31-24. Пример пары begin-end, не выделенной отступами (Java)

- Ключевое слово begin выровнено по границе for.

•-for ( int i = 0; i < MAX LINES; i++ ) {

- В выражениях сделан отступ относительно begin.

->Г ReaciLine( i );

ProcessLine( i );

[- Слово end также выровнено по границе структуры for.

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

Листинг 31-25 демонстрирует абстрактное представление этого подхода:

Листинг 31-25. Абстрактный пример вводящего в заблуждение выравнивания

Е

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

Избегайте двойных отступов при использовании begin и end Следствием правила относительно использования пары begin-end без отступов является случай, касающийся дополнительных отступов после begin-end. Этот стиль, продемонстрированный в листинге 31-26, содержит отступы как перед begin и end, так и перед выражениями, которые они охватывают:

Ш Листинг 31-26. Пример неуместного двойного отступа в блоке begin-end (Java)


for ( int i = 0; i < MAX LINES; i++ ) {



В выражениях после begin сделан лишний отступ.

ReaclLine( i ); ProcessLine( i );

Еще один пример стиля, внешне привлекательного, но нарушающего Основную теорему форматирования. Исследования показали, что с точки зрения понимания программы, использующие одинарные и двойные отступы, не отличаются друг от друга (Miaria et al., 1983), но приведенный стиль неточно отображает логическую структуру программы. ReadLineQ и ProcessLine() показаны так, будто они подчинены паре begin-end, что не соответствует действительности. Этот подход также преувеличивает сложность логической структуры программы. Какая из структур, приведенных в листингах 31-27 и 31-28, выглядит сложнее?

Листинг 31-27. Абстрактная структура 1

Листинг 31-28. Абстрактная структура 2

Обе являются абстрактными представлениями структуры цикла for. Структура 1 выглядит сложней, хотя и представляет тот же код, что и Структура 2. Если бы вам понадобилось создать 2 или 3 уровня вложенности операторов, то из-за двойных отступов вы получили бы 4 или 6 уровней отступов. Такое форматирование выглядело бы сложнее, чем на самом деле. Избавьтесь от этой проблемы, эмулировав явные блоки или применив begin и end в качестве границ блока, выравнивая begin и end так же, как и выражения, которые они охватывают.

Другие соглашения

Хотя отступы в блоках являются главным вопросом форматирования управляющих структур, вы также можете столкнуться с другими проблемами, поэтому далее я привожу еще несколько советов.

Используйте пустые строки между абзацами Некоторые блоки не разграничиваются с помощью пар begin-end. Логический блок - группа подходящих друг к другу операторов - должны рассматриваться так же, как абзацы в обычной книге. Отделяйте их друг от друга с помощью пустых строк. Листинг 31-29 представляет пример абзацев, которые следует разделить:



Листинг 31-29. Пример кода, который следует сгруппировать и разбить на абзацы (С++)

cursor.start = startingScanLine; cursor.end = endingScanLine; window.title = editWindow.title; window.dimensions = editWindow.dimensions;

window.foregroundColor = userPreferences.foregroundColor; cursor.blinkRate = editMode.blinkRate;

window.backgroundColor = userPreferences.backgroundColor; SaveCursor( cursor ); SetCursor( cursor );

Этот код выглядит неплохо, но пустые строки позволят улуч- 1в51фес11ая Фсша Есяи вы шить его с двух точек зрения. Во-первых, если у вас есть груп- придерживаетесь f!ponecca про-па операторов, не требуюш,их выполнения в определенном грттрттт с псевдокодом, порядке, заманчиво объединить их именно так. Вам не надо ш код автоматически разби-усовершенствовать порядок выражений для помощи компь- абзацы (с«. главу 9). ютеру, но читатели-люди оценят дополнительные подсказки о том, какие операторы выполнять в определенном порядке, а какие - просто расположены рядом друг с другом. Дисциплина добавления пустых строк в коде программы заставляет вас тщательней обдумывать вопрос, какие операторы на самом деле подходят друг другу. Исправленный фрагмент кода, представленный в листинге 31-30, показывает, как организовать данный набор операторов.

Листинг 31-30. Пример кода, который правильно сгруппирован и разбит на абзацы (С++)

Эти строки настраивают текстовое окно.

"window.dimensions = editWindow.dimensions; window.title = editWindow.title;

window.backgroundColor = userPreferences.backgroundColor; -window.foregroundColor = userPreferences.foregroundColor;

I- Эти строки устанавливают параметры курсора и должны быть отделены от предыдущих строк.

"cursor.start = StartingScanLine; cursor.end = endingScanLine; cursor.blinkRate = editMode.blinkRate; SaveCursor( cursor ); .SetCursor( cursor );

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

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



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.0065