O komentarzach w kodzie

Zebrałem tutaj kilka ciekawych spostrzeżeń znalezionych w odmętach Internetu. Zapraszam do zajrzenia 🙂

O dążeniu do doskonałości

Każdy komentarz w programie jest jak przeprosiny dla czytelnika. „Przepraszam, że mój kod jest tak nieprzejrzysty, że nie można go zrozumieć patrząc na niego”. Musimy po prostu zaakceptować fakt, że nie jesteśmy doskonali, ale starać się być doskonałymi i przepraszać, gdy zajdzie taka potrzeba.

Ktoś kiedyś powiedział

1) Pisz komentarze tylko do kodu, który jest trudny do zrozumienia.
2) Staraj się nie pisać kodu, który jest trudny do zrozumienia.

Bądź DRY

Samodokumentujący się kod jest dobrym przykładem zasady „DRY” (Don’t Repeat Yourself). Nie powielaj w komentarzach informacji, które są lub mogą być zawarte w samym kodzie.

Pozostaw komentarz

Twój adres e-mail nie zostanie opublikowany. Wymagane pola są oznaczone *