[D3xxT3r]

Czytając "Czysty kod. Podręcznik dobrego programisty" natrafiłem na rozdział o komentarzach, autor uważa, że są one zbędne w kodzie i do niczego się raczej nie przydają, jakie jest wasze zdanie na ten temat Mirki? #programowanie #informatyka

[Z.....y]

@D3xxT3r: IMHO przydają się np. w assembly, bo idzie się pogubić, ale ogólnie to nowoczesne języki programowania ułatwiają tworzenie samodokumentującego kodu. Natomiast jak masz jakiś dziki algorytm to dla dobra ogółu wlep komentarz.

[fegwegw]

@D3xxT3r: czasem się przydają, ale faktycznie, ogólną zasadą jest, że nie powinno ich być - kod powinien być na tyle czytelny, że komentarze powinny być niepotrzebne.

Dopuszczalne są w przypadku, gdy dany fragment kodu robi jakieś skomplikowane operacje domenowe, liczy jakieś zarkęcone algorytmy, itp, i użycie nie jest do końca jasne.

Przykładem dobrego komentarza będzie:

// ten fragment robi coś, bo tego wymaga X

a złego:

// tutaj iterujemy kolekcję, i

[TheNewIcek]

@fegwegw: @D3xxT3r: piekny przyklad komentarza, ktory widuje w wielu projektach to: // konstruktor :D, podobnie: metoda setValue, komentarz: // set the value itp.

[D3xxT3r]

@TheNewIcek: no własnie autor podaje jako przykład fragment kodu Tomcata, gdzie występuje coś takiego

[BaKaZa]

@fegwegw: +1, dobrze napisany kod nie wymaga komentarzy. Z nazw klas, metod powinno wynikać co robią. Lepiej wyklepać długą nazwę, niż później klepać komentarze.

[M.....o]

@TheNewIcek: Raz widziałem na reddicie gościa który komentował dosłownie każdą linijkę kodu. xD

int counter; // counter variable

[TheNewIcek]

@MMurzinio: jedyny jezyk gdzie takie komentarze sa zasadne to assembler, tam to nawet lepiej jak jest wiecej komentarzy niz kodu. W kazdym wysoko poziomowym jezyku jedyny przypadek gdzie powinny byc komentarze to:\
1. jak mowi @fegwegw, jakies specyficzne algorytmy
2. dokumentacja API biblioteki/frameworku

[D3xxT3r]

@TheNewIcek: z tą dokumentacją autor też jest dość ostrożny

[TheNewIcek]

@D3xxT3r: to juz zalezy, temat bardzo dyskusyjny w tym przypadku

[kuba25800]

Tja, są zbędne... bull shit. Wiadome, że te typu //costructor czy //setValue to idiotyzm, ale nie raz jakis trudniejszy kawałem kodu opatrzony komentarzem jest pomocny

[alex-fortune]

@D3xxT3r: IMO tak z 90% prawda. Dobry model jest podstawą rozmowy o kodzie i biznesie jednocześnie, więc komentarze są do niego zbędne. Aaale kod to nie tylko kod biznesowy, zostają jeszcze wszelkiego rodzaju usługi pomocnicze i inne komponenty - a tam komentarze bywają przydatne.

@kuba25800: Podejrzewam, że skoro piszesz coś takiego jak setValue, to nic dziwnego, że potrzebujesz komentarzy ( ͡° ͜ʖ ͡°)

[kuba25800]

@alex-fortune: ?? nie rozumiem o co Ci chodzi, ja tylko odnioslem sie do komentarz @TheNewIcek

[Kaczus2B]

@D3xxT3r: Komentarze się przydaja w nagłówkach/opisach interfaców publicznych, by potem automat mógł wygenerować ładną dokumentację. Ogólnie należy pisac tak by był on zbędny. Stosować jedynie by zwrócić uwagę na nietypowe rozwiązanie (pomijam komentarze dla pamięci typu "todo", bo to czas przejściowy, ja czasem lubię np sobie w komentarzu opisać nim zacznę implementować jak funkcja w danych przypadkach ma się zachowywać, i te opisy znikają, gdy postępuje implementacja)

[biwalencik]

@TheNewIcek
Tego typu komentarze w 99% pochodza z automatu, ktory na podstawie UMLa generuje szkielet klas.

[b.....r]

pomijam komentarze dla pamięci typu "todo", bo to czas przejściowy

@Kaczus2B: ta, przejściowy ( ͡° ͜ʖ ͡°)

[Kaczus2B]

@benethor: zależy jak kto pisze, ja po prostu robię sobie notatki bo przeciez jak wracam po weekendzie moglbym zapomniec co mialem na mysli rozgrzebujac fragment. Oczywiście mógłbym robić notatki na kartce obok, ale w kodzie jest mi wygodniej na kartce obok mam tylko ze mam sie tym zajac, natomiast w kodzie mam napisane jak. Nawet nie używam sekwencji todo, po prostu taki skrot myslowy - ze zastosowanie do tego co ma