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

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

Форматирование строк с продолжением

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

Далее приведен здравый, последовательный подход, особенно полезный в Java, С, С++, Visual Basic и других языках, поощряющих длинные имена переменных.

Сделайте так, чтобы незавершенность выражения была очевидна

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

Листинг 31-37. Примеры очевидно незавершенных выражений (Java)

- Оператор && сигнализирует, что выражение не завершено.

-Awhile ( pathName[ startPath + position ]!=; ) && ( ( StartPath + position ) <= pathNane.length() )

- Знак плюс сигнализирует, что выражение не завершено.

->totalBill = totalBill + customerPurchases[ customerlD ] + SalesTax( customerPurchases[ customerlD ] );

- Запятая сигнализирует, что выражение не завершено.

->DrawLine( window.north, window.south, window.east, window.west, currentWidth, currentAttribute );

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

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

Листинг 31-38. Примеры очевидно незавершенных выражений -альтернативный стиль (Java)

while ( pathName[ startPath + position ]!=; )

&& ( ( StartPath + position ) <= pathName.lengthO )



totalBill = totalBill + custofnerPurchases[ customerlD ] + SalesTax( customerPurchases[ customerlD ] );

Хотя такой стиль не приведет к появлению синтаксической ошибки при повиса-нии операторов вв- или +, он сильно упрощает поиск операторов по левой границе столбца - там, где текст выровнен, а не по правой - где край текста неровный. Его дополнительное преимущество в том, что он позволяет пояснить структуру операций, как показано в листинге 31-39.

Листинг 31-39. Пример стиля, поясняющего смысл сложной операции (Java)

totalBill = totalBill

+ customerPurchases[ customerlD ] + CitySalesTax( customerPurchases[ customerlD ] ) + StateSalesTax( customerPurchases[ customerlD ] ) + FootballStadiumTaxO

- SalesTaxExemption( customerPurchases[ customerlD ] );

Piicnojuizaume сильно связанные элементы вместе Разбивая строку на части, оставляйте рядом взаимосвязанные элементы: обращения к массиву, аргументы метода и т.д. Пример, приведенный в листинге 31-40, демонстрирует плохой вариант:

Листинг 31-40. Пример неправильного разбиения строки (Java)

customerBill = PreviousBalance( paymentHistory[ customerlD ] ) + LateCharge( paymentHistory[ customerlD ] );

Надо признать, что такой разрыв строки соответствует принципу подчеркивания очевидности незавершенных выражений, но это сделано так, что надобности затрудняет чтение выражения. Можно придумать ситуации, когда такое разбиение будет оправданным, но это не тот случай. Лучше оставить все обращения к массиву на одной строке. Листинг 31-41 показывает лучшее форматирование:

Листинг 31-41. Пример правильного разбиения строки (Java)

customerBill = PreviousBalance( paymentHistory[ customerlD ] ) + LateCharge( paymentHistory[ customerlD ] );

При переносе строк в вызове метода используйте отступ стандартного размера Если в циклах и условных выражениях вы обычно делаете отступ в три пробела, то при переносе строки в вызове метода тоже сделайте отступ в три пробела. Листинг 31-42 содержит несколько примеров:

Листинг 31-42. Примеры переноса строк в вызовах методов с применением стандартного размера отступов (Java)

DrawLine( window.north, window.south, window.east, window.west,

currentWidth, currentAttribute ); SetFontAttributes( faceName[ fontid ], size[ fontid ], bold[ fontid ],

italic[ fontid ], syntheticAttribute[ fontid ].underline,

syntheticAttribute[ fontid ].strikeout );



Одной из альтернатив такому подходу служит выравнивание перенесенных строк под первым аргументом, как показано в листинге 31-43:

Листинг 31-43. Пример отступов при переносе строк в вызове методов, позволяющих выделить имена методов (Java)

DrawLine( window.north, window.south, window.east, window.west,

currentWidth, currentAttribute ); SetFontAttributes( faceName[ fontid ], size[ fontid ], bold[ fontid ],

italic[ fontid ], syntheticAttribute[ fontid ].underline,

syntheticAttribute[ fontid ].strikeout );

С эстетической точки зрения, в сравнении с первым вариантом этот код выглядит несколько неровно. Кроме того, этот подход тяжело сопровождать, так как имена методов и аргументов могут изменяться. Большинство программистов со временем склоняются к использованию первого стиля.

Упростите поиск конца строки с продолжением Одна из проблем показанного выше подхода - сложность поиска конца каждой строки. Альтернативой может служить размещение каждого элемента на отдельной строке и выделение окончания всей группы с помощью закрывающей скобки (листинг 31-44).

Листинг 31-44. Пример форматирования переноса строк в вызовах методов, в котором каждый аргумент размещается на отдельной строке (Java)

DrawLine(

window.north, window.south, window.east, window.west, currentWidth, currentAttribute

SetFontAttributes( faceName[ fontid ], size[ fontid ], bold[ fontid ], italic[ fontid ],

syntheticAttribute[ fontid ].underline, syntheticAttribute[ fontid ].strikeout

Ясно, что такой подход требует много места. Однако если аргументами функции являются длинные названия полей объектов или имена указателей, например, такие, как два последних в приведенном примере, размещение одного аргумента в строке существенно улучшает читаемость. Знаки ); в конце блока делают заметным его окончание. Вам также не придется переформатировать код при добавлении параметра - вы просто добавите новую строку.

На практике только небольшая часть методов нуждается в разбиении на строки. Остальные можно располагать на одной строке. Любой из трех вариантов фор-



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