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

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)

for ( i = 2; i <= num; i++ ) { meetsCriteria[ i ] = true; }

for ( i = 2; i num / 2; i++ ) { j = i + i;

while ( j num ) { meetsCriteria[ j ] = false; J = j + i;

for ( i 1; i <= num; i++ ) {

if ( meetsCriteria[ i ] ) {

System.out.println ( i + " meets criteria." );

RepeiTHaH ссылка Здесь ne- Что, по-вашему, делает этот метод? Его непонятность не ременная ШоШвЫтЬы йс- имеет никакого обоснования. Он плохо документирован, но нояьзуетсйисключйтепьноради дело не в отсутствии комментариев, а в плохом стиле про-

пояшнйя операции. О добае- граммирования. Имена переменных неинформативны, а

ттт переменных с целью по- .

яснения операций ш. подраз- " форматирования груб. Вот улучшенный вариант того

деп «Упрощение сложных 8ыра- же кода - простое улучшение стиля программирования

жеиий» раздела 19.1. делает его смысл гораздо яснее:

Пример документирования кода без использования комментариев -за счет хорошего стиля (Java)

for ( primeCandidate = 2; primeCandidate <= num; primeCandidate++ ) { isPrime[ primeCandidate ] = true;

for ( int factor = 2; factor < ( num / 2 ); factor++ ) { int factorableNumber = factor + factor; while ( factorableNumber <= num ) { isPrime[ factorableNumber ] = false; factorableNumber = factorableNumber + factor;

for ( primeCandidate = 1; primeCandidate <= num; primeCandidate++ ) { if ( isPrime[ primeCandidate ] ) {

System.out.println( primeCandidate + " is prime." );

Одного взгляда на этот код достаточно, чтобы понять, что он имеет какое-то отношение к простым числам (prime numbers). Второй взгляд показывает, что он



находит простые числа от / до Num. Что касается первого фрагмента, то, взглянув на него пару раз, вы даже не поймете, где завершаются циклы.

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

Контрольный список:

самодокументирующийся код http; CC2e.COfn/3252

Классы

□ Формирует ли интерфейс класса согласованную абстракцию?

□ Удачное ли имя присвоено классу? Описывает ли оно главную цель класса?

□ Ясно ли интерфейс описывает применение класса?

□ Достаточно ли абстрактен интерфейс класса, чтобы можно было не думать о том, как реализованы его сервисы? Можете ли вы рассматривать класс как «черный ящик»?

Методы

□ Точно ли имя каждого метода описывает выполняемые в нем действия?

□ Выполняет ли каждый метод одну и только одну хорошо определенную задачу?

□ Все ли части метода, которые целесообразно поместить в отдельные методы, сделаны отдельными методами?

□ Очевиден ли и ясен ли интерфейс каждого метода?

Имена данных

□ Достаточно ли описательны имена типов, чтобы помогать документировать объявления данных?

□ Удачно ли названы переменные?

□ Переменные используются только с той целью, в соответствии с которой они названы?

□ Присвоены ли счетчикам циклов более информативные имена, чем /, j и /с?

□ Используете ли вы грамотно названные перечисления вместо самодельных флагов или булевых переменных?

□ Используете ли вы именованные константы вместо магических чисел или магических строк?

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

Организация данных

□ Используете ли вы дополнительные переменные для пояснения кода?

□ Сгруппированы ли обращения к переменным?

□ Просты ли типы данных? Способствуют ли они минимизации сложности?

□ Обращаетесь ли вы к сложным данным при помощи абстрактных методов доступа (абстрактных типов данных)?



Управление

□ Очевиден ли номинальный путь выполнения кода?

□ Сгруппированы ли связанные операторы?

□ Вынесены ли относительно независимые группы операторов в отдельные методы?

□ Следует ли нормальный вариант после if, а не после else?

□ Просты ли управляющие структуры? Способствуют ли они минимизации сложности?

□ Выполняет ли цикл одну и только одну функцию, как это делает хорошо спроектированный метод?

□ Минимизировали ли вы вложенность?

□ Упростили ли вы булевы выражения путем использования дополнительных булевых переменных, булевых функций и таблиц принятия решений?

Форматирование

□ Характеризует ли форматирование программы ее логическую структуру? Проектирование

□ Прост ли код? Избегаете ли вы «хитрых» решений?

□ Скрыты ли детали реализации настолько, насколько возможно?

□ Стараетесь ли вы писать программу в терминах проблемной области, а не структур вычислительной техники или языка программирования?

32.3. Комментировать или не комментировать?

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

Комменто

Действующие лица:

ФРАСИМАХ Неопытный пурист теории, который верит всему, что читает.

КАЛЛИКЛ Закаленный в боях представитель старой школы - «настоящий» программист.

ГЛАВКОН Молодой, самоуверенный, энергичный программист.

ИСМЕНА Опытная разработчица, уставшая от громких обещаний и просто

желающая найти несколько работающих методик.

СОКРАТ Мудрый опытный программист.

Мизансцена:

Завершение ежедневного собрания группы

- Желает ли кто-то обсудить еще что-нибудь, прежде чем мы вернемся к работе?

- спрашивает Сократ.

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



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