Добавил:
Опубликованный материал нарушает ваши авторские права? Сообщите нам.
Вуз: Предмет: Файл:
книги хакеры / Питер_Гудлиф_Ремесло_программиста_Практика_написания_хорошего_кода.pdf
Скачиваний:
16
Добавлен:
19.04.2024
Размер:
9.23 Mб
Скачать

 

 

 

 

hang

e

 

 

 

 

 

 

C

 

E

 

 

 

X

 

 

 

 

 

-

 

 

 

 

 

d

 

F

 

 

 

 

 

 

t

 

D

 

 

 

 

 

 

 

i

 

 

 

 

 

 

 

 

r

P

 

 

 

 

 

NOW!

o

 

 

 

 

 

 

 

 

 

 

 

BUY

 

 

 

 

 

to

 

 

 

 

w Click

 

 

 

Резюмеm

 

 

 

 

w

 

 

 

 

 

 

 

 

 

w

 

 

 

 

 

 

 

o

 

.

 

 

 

 

 

.c

 

 

p

 

 

 

 

g

 

 

 

 

df

 

 

n

e

 

 

 

 

-xcha

 

 

 

 

 

 

 

hang

e

 

 

 

 

 

 

 

C

 

E

 

 

 

 

X

 

 

 

 

 

 

-

 

 

 

 

 

d

 

 

F

 

 

 

 

 

 

t

 

 

D

 

 

 

 

 

 

 

i

 

 

 

 

 

 

 

 

 

r

P

 

 

 

 

 

NOW!

o

 

 

 

 

 

 

 

 

 

 

 

 

BUY

 

 

 

 

 

 

to

 

 

 

 

 

129Click

 

 

 

 

 

m

 

 

 

 

 

 

w

 

 

 

 

 

 

 

o

 

 

w

 

 

 

 

 

 

 

 

w

 

 

 

 

 

 

.c

 

 

.

 

 

 

 

 

 

 

 

p

 

 

 

 

g

 

 

 

 

 

df

 

 

n

e

 

 

 

 

 

-x cha

 

 

 

 

вующего кода (точнее, его отсутствия). Конечно, если вы действитель% но хотите повысить качество этого кода, то и комментарии нужно под% вергнуть переработке. Обнаружив комментарий, содержащий невер% ные сведения или ошибки, вы должны переписать его в процессе со% провождения данного кода.

Увидев предупреждающие флажки типа XXX, отнеситесь к ним со всем вниманием и осторожностью. Следите также за операторами вывода, которые закомментированы. Они явно указывают на то, что в этом мес% те кода были проблемы; изучите этот код особенно внимательно!

Помните о постепенной деградации комментариев. Если в коммента% рии сказано, что нечто определено в foo.c, нет никакой уверенности, что так оно и есть до сего дня. Всегда верьте коду и сомневайтесь в ком% ментариях.

Резюме

Главное – описать увиденное так, чтобы больше не повторяться.

Делмор Шварц

Мы пишем много комментариев. Это вызвано тем, что мы пишем мно% го кода. Важно научиться писать правильные комментарии, иначе наш код может потонуть под грузом бестолковых или устаревших комментариев.

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

Хорошие программисты…

Стремятся писать малочис# ленные, но добротные ком% ментарии

В комментариях объясняют

почему

Стараются писать хороший код, а не уйму комментариев

Пишут полезные и разумные комментарии

Плохие программисты…

Не понимают разницы между пло% хими и хорошими комментариями

В комментариях объясняют как

Пишут комментарии, не понятные никому, кроме них самих

Пытаются подкрепить плохой код многочисленностью комментариев

Помещают в исходные тексты лишнюю информацию (типа исто% рии версий и т. д.)