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

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

ствлять иным методом, например InitializeExpenseDataQ. Имя метода явно указывает на то, что он должен быть вызван перед другими расчетами расходов.

Называйте методы так, чтобы зависимости были очевидными В примере на Visual Basic метод ComputeMarketingExpenseO назван неправильно, поскольку он делает больше, чем просто вычисляет расходы на маркетинг: он еще инициализирует члены класса. Если вы против создания отдельного метода для инициализации данных, дайте по крайней мере методу ComputeMarketingExpenseO имя, описывающее все выполняемые им функции. В данном случае ComputeMarke-tingExpenseAndlnitializeMemberDataQ будет более адекватным именем. Вы можете сказать, что это имя ужасно, потому что слишком длинное. Но оно описывает то, что делает метод и вовсе не ужасно. Ужасен сам метод!

Используйте параметры методов, чтобы сделать за-Щщтпдл Ш1Ш Об ис* * , . ,

пошоеании методов и их висимости очевидными Возвращаясь к примеру на Visual

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

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

Пример данных, которые позволяют предположить порядковую зависимость (Visual Basic)

InitializeExpenseData( expenseData ) ComputeMarketingExpense( expenseData ) ComputeSalesExpense( expenseData ) ComputeTravelExpense( expenseData ) ComputePersonnelExpense( expenseData ) DisplayExpenseSummary( expenseData )

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

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

Пример данных и вызовов методов, которые указывают на порядковую зависимость (Visual Basic)

expenseData = InitializeExpenseData( expenseData ) expenseData = ComputeMarketingExpense( expenseData ) expenseData = ComputeSalesExpense( expenseData ) expenseData = ComputeTravelExpense( expenseData ) expenseData = ComputePersonnelExpense( expenseData ) DisplayExpenseSummary( expenseData )

Данные могут также указывать, что порядок выполнения не имеет значения, как в этом случае:



Пример данных, которые не указывают на порядковую зависимость (Visual Basic)

ComputeMarketingExpense( marketingData ) ComputeSalesExpense( salesData ) ComputeTravelExpense( travelData ) ComputePersonnelExpense( personnelData )

DisplayExpenseSummary( marketingData, salesData, travelData, personnelData )

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

Документируйте неявные зависимости с помощью комментариев Попробуйте, во-первых, написать код без порядковых зависимостей, во-вторых - написать код, который делает зависимости очевидными. Если вам все еще кажется, что зависимости видны недостаточно ясно, задокументируйте их. Документирование неявных зависимостей - один из аспектов документирования допущений, сделанных при кодировании, что необходимо для написания систем, пригодных для сопровождения и модификации. В примере на Visual Basic будет полезно поместить такие комментарии:

Пример выражений, в которых порядковые зависимости скрыты, но разъясняются с помощью комментариев (Visual Basic)

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

expenseData. Метод DisplayExpenseSummary должен вызываться последним,

так как он зависит от данных, вычисленных другими методами.

InitializeExpenseData

ComputeMarketingExpense

ComputeSalesExpense

ComputeTravelExpense

ComputePersonnelExpense

DisplayExpenseSummary

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

Проверяйте зависимости с помощью утверждений или кода обработки ошибок Если последовательность кода достаточно критична, вы можете использовать утверждения или статусные переменные и код обработки ошибок, чтобы задокументировать необходимый порядок. Например, в конструкторе класса вы можете инициализировать член класса isExpenseDatalnitialized значением false. Затем в InitializeExpenseDataO вы устанавливаете isExpenseDatalnitialized в true. Каждая функция, зависящая от инициализации expenseData, может проверить, установлено ли значение isExpenseDatalnitialized в true, прежде чем выполнять операции с expenseData. Если зависимости между методами глубже, вам могут потребоваться такие переменные, как isMarketingExpenseComputed, isSalesExpenseComputed и т. д.



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

14.2. Операторы, следующие в произвольном порядке

Вам могут встречаться ситуации, когда кажется, что порядок выполнения нескольких выражений или нескольких блоков кода не имеет значения. Одно выражение не зависит от другого и логически из него не следует. Но поскольку упорядоченность влияет на читабельность, производительность и качество сопровождения, вы можете использовать второстепенные критерии для определения порядка следования выражений или блоков кода. Главный принцип - это Принцип Схожести: Располагайте взаимосвязанные действия вместе.

Размещение кода для чтения сверху вниз

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

Пример плохого кода, в котором приходится перескакивать с места на место (С++)

MarketingData marketingData; SalesData salesData; TravelData travelData;

travelData.ComputeQuarterly(); salesData.ComputeQuarterly(); marketingData.ComputeQuarterly();

salesData.ComputeAnnual(); mar ketingData.ComputeAnnual(); travelData.ComputeAnnual();

salesData.PrintO; travelData.PrintO; marketingData.Print();

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



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