“Skoro kod wymaga komentarza, to oznacza, że jest do dupy”
Spotkałeś się z takimi lub podobnymi słowami? Ja tak i to dość często. Tylko czy to aby na pewno prawda? Jak to w życiu bywa, odpowiedź na to pytanie jest niejednoznaczna. Oczywiście są sytuacje, w których kod wymaga dodania komentarzy ze względu na swą wątpliwą jakość. Bywa jednak, że są one na wagę złota. Niewątpliwie przydają się podczas pracy nad rozszerzeniem lub modernizacją funkcjonalności bogatej w wiedzę domenową.
Teoretycznie ta wiedza powinna się znaleźć w dokumentacji, ale różnie z tym bywa. Nawet jeśli prowadzona jest ona rzetelnie, to istnieje bardzo duże prawdopodobieństwo, że programiście zwyczajnie nie będzie się chciało przekopywać przez sterty materiałów, by dotrzeć do poszukiwanego skrawka informacji. W takiej sytuacji istnieją dwie najprawdopodobniejsze opcje. Programista dopyta eksperta domenowego lub sam dokona założeń. Niestety z mojego doświadczenia opcja numer dwa jest częściej wybierana. Co skutkuje pojawianiem się błędów. Można, tego w uniknąć dodając podczas tworzenia funkcjonalności komentarze.
Programista jest inteligentny, więc zbędne jest pisanie, jak kod działa. Za to istotne jest wspomnienie, jaki problem biznesowy rozwiązuje i jak wpływa na kolejny etap procesu.
Pamiętaj, że poszukiwaczem tej cennej wiedzy możesz być ty sam – autor kodu. Wystarczy, że wrócisz do modułu po długim czasie. Wtedy będziesz zadowolony, że poświęciłeś te kilka minut i napisałeś, po co jest dany kod, uwierz, to naprawdę dużo daje.
Bądź kreatywny. Nikt ci przecież nie zabrania na przykład robić prostych rysunków w komentarzach. Rób wszystko, co przychodzi ci na myśl, cały czas mając jeden cel w głowie: KOD MUSI BYĆ PROSTY DO ZROZUMIENIA.
Jak używać komentarzy w C#
W C# możemy używać dwóch typów komentarzy. Różnią się one zasięgiem. Pierwszym z nich jest komentowanie jednej linii. Wykonać tę czynność możemy, dodając przed interesującą nas linią lub w jej części znaki: // zobaczmy przykład:
Komentowanie jednej linii:
Drugim sposobem jest komentowanie zakresu tekstu bądź kodu. Taki komentarz rozpoczynamy od znaków /* a kończymy znakami */
Zobaczmy przykład:
Nie bój się pisać komentarzy.