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

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-55:

Листинг 31-55. Примеры расположения звездочек в объявлениях указателей (С++)

EmployeeList* employees; File* inputFile;

При размещении звездочки рядом с именем типа, а не переменной возникает опасность, что в случае добавления нового объявления в той же строке звездочка будет относиться только к первой переменной, хотя визуальное форматирование наводит на мысль, что она применяется ко всем переменным в строке. Вы можете решить эту проблему, поместив звездочку рядом с именем переменной, а не с именем типа (листинг 31-56):

Листинг 31-56. Пример расположения звездочек в объявлениях указателей (С++)

EmployeeList *employees; File *inputFile;

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

Наилучший вариант - объявление и использование типа-указателя (листинг 31-57): Листинг 31-57. Пример правильного применения типa-yкaзateля в объявлениях (С++)

EmployeeListPointer employees; FilePointer inputFile;

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

31.6. Размещение комментариев

Хорошо оформленные комментарии могут значительно улуч- перекрвстнай ссылка О других шить читаемость программы; плохо - сильно ей повредить, аспектах комментариев см. та-Делайте в комментарии такой же отступ, как ив соответствующем ему коде Визуальные отступы вносят важный вклад в понимание логической структуры программы, и хорошие комментарии не мешают визуальному выравниванию. Например, что можно сказать о логической структуре метода, приведенного в листинге 31-58?

Листинг 31 -58. Пример комментариев с неправильными

отступами (Visual Basic)

For transactionld = 1 To totalTransactions получаем информацию о транзакции



GetTransactionType( transactionType ) GetTransactionAmount( transactionAmount )

обрабатываем транзакцию в зависимости от ее типа If transactionType = Transaction Sale Then AcceptCustomerSale( transactionAmount )

Else

If transactionType - Transaction CustomerReturn Then

процесс либо оформляет автоматический возврат, либо в случае необходимости ждет подтверждения от менеджера

If transactionAmount >= MANAGER APPROVAL LEVEL Then

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

GetMgrApproval( isTransactionApproved )

If ( isTransactionApproved ) Then

AcceptCustomerReturn( transactionAmount )

Else

RejectCustomerReturn( transactionAmount ) End If Else

подтверждение менеджера не требуется, поэтому оформляем возврат AcceptCustomerReturn( transactionAmount ) End If End If End If Next

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

Код, приведенный в листинге 31-59, абсолютно идентичен предыдущему примеру из листинга 31-58 за исключением отступов в комментариях.

Листинг 31-59. Пример комментариев с правильными отступами (Visual Basic)

For transactionid = 1 To totalTransactions получаем информацию о транзакции GetTransactionType( transactionType ) GetTransactionAmount( transactionAmount )

обрабатываем транзакцию в зависимости от ее типа If transactionType = Transaction Sale Then AcceptCustomerSale( transactionAmount )



Else

If transactionType = Transaction CustomerReturn Then

процесс либо оформляет автоматический возврат, либо в случае необходимости ждет подтверждения от менеджера If transactionAmount >= MANAGER APPROVAL LEVEL Then

пытаемся получить подтверждение от менеджера, а затем оформляем или отменяем возврат средств в зависимости от полученного подтверждения GetMgrApproval( isTransactionApproved ) If ( isTransactionApproved ) Then

AcceptCustomerReturn( transactionAmount ) Else

RejectCustomerReturn( transactionAmount ) End If Else

подтверждение менеджера не требуется, поэтому оформляем возврат AcceptCustomerReturn( transactionAmount ) End If End If End If Next

Логическая структура кода в листинге 31-59 более прозрачна. В ходе одного исследования эффективности комментариев выяснилось, что их применение не всегда является абсолютным достоинством. Автор объяснил это тем, что они «нарушают процесс визуального просмотра программы» (Shneiderman, 1980). Из этих примеров становится понятно, что стиль комментариев очень сильно влияет на их «разрушающую» способность.

Отделяйте каждый комнеитарий хотя бы одной пустой строкой Наиболее эффективный способ беглого просмотра программы - прочитать комментарии, не читая при этом код. Выделение комментариев с помощью пустых строк помогает читателю просматривать код. В листинге 31-60 приведен пример:

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

комментарий О

CodeStatementZero;

CodeStatementOne;

комментарий 1

CodeStatementTwo;

CodeStatementThree;

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



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