Ta kwestia od jakiegoś czasu zdaje się dzielić programistów niemalże tak mocno jak podział ...

Niniejszy blog oparłem na dotnetowym CMS'ie Orchard, jednak w standardowym zestawie modułów brakowało mi takiego, który wyświetlałby najnowsze komentarze do postów w formie listy. Postanowiłem więc stworzyć własny widget, który byłby za to odpowiedzialny (efekt można obejrzeć w lewym dolnym placeholderze na tej stronie). Poniżej opis tworzenia własnego widgetu.Przygotowanie modułu Na początek należy utworzyć nowy moduł Orcharda (dokumentacja dostępa tutaj). Na początek, trzeba upewnić się, że mamy zains...

Programiści dzielą się na: Tych, którzy piszą bardzo dużo komentarzy, czasami prawie w każdej linijce. Tych spotkałem niewielu.Tych, którzy w ogóle ich nie piszą, nawet jeśli napisali kod, którego nie da się zrozumieć bez choćby odrobiny komentarza. Tych ortodoksów jest już więcej.Największa grupę stanowią natomiast programiści, którzy sytuują się gdzieś pomiędzy tymi dwiema skrajnościami. Kiedy zaczynałem programować pisałem bardzo dużo komentarzy. Wiele z nich było zupełnie niepotrze...

Dużo się na ten temat pisze i dużo jest też pytań. Dla mnie kwestia jest dość prosta. Weźmy na przykład ten fragment kodu, który kiedyś popełniłem. Tak naprawdę patrząc na niego ciężko jest wywnioskować co on robi - nazwa funkcji, której nie podałem już powie trochę więcej. Ale jest to jakiś konkretny algorytm, który wykonuje konkretną pracę. Teraz jakie jest moje spojrzenie na dokumentowanie kodu...

Kontrowersyjny esej o kodzie czytelnym, część 4: komentarze Komentarze w kodzie metod pomagają nam zrozumieć, co miała na myśli osoba implementująca algorytm realizowany przez daną metodę: dlaczego ten if wygląda tak i po co jest ta pętla. Komentarze pozwalają też na oznaczenie etykietami pewnych logicznych fragmentów metody, które stanowią spójną całość. Takie fragmenty są też często zamykane w regiony. Zarówno komentarze, jak i regiony, wewnątrz metod są znakiem, że kod potrzebuje refaktoryzacji. Sam ...