wtorek, 13 października 2009

Komentowanie kodu

Jestem w trakcie lektury "Clean Code. A Handbook of Agile Software Craftsmanship". Książka zawiera ogrom wiedzy, która mogłoby się wydawać niewiele zmienia w naszym codziennym pisaniu. Jestem dopiero na jej początku (rozdział 4 - Comments), jednak już zauważyłem że na kilka spraw zaczynam spoglądać trochę inaczej.
Wszyscy, zawsze i wszędzie mówią: "komentarze muszą być wszędzie", a tu proszę:

Comments are not like Schindler's List. They are not "pure good." Indeed, comments are, at best, a necessary evil.

I dalej:

The proper use of comments is to compensate for our failure to express ourself in code. Note that I used the word failure. I meant it.


Chyba się zgodzicie, że coś w tym jest? Swoją drogą polecam książkę, a sam jestem ciekaw co dalej.

2 komentarze:

croofec pisze...

Teoretycznie kod w Javie powinien być samo komentujący. Jednoznaczne i jasno określone nazwy metod czy zmiennych.

BTW fajny blog, dodałem do rssa :)

Maciej Matecki pisze...

Miło słyszeć. Aż mi się zachciało nawet coś nowego opublikować :)