Jeśli projekt znajduje się pod kontrolą wersji (i powinno to być w dzisiejszych czasach, ale nigdy nie wiadomo) i jest ogromna porcja nieaktualnych komentarzy, usuwam przystawkę i pozostawiam nowy komentarz, że "usunąłem garść starych komentarzy, które już nie wydawały się pouczające, i przesyłam z uwagą, że usunąłem nieaktualne komentarze.
W końcu usunę komentarz, który wspomina o usunięciu lub zastąpi go komentarzami, które dotyczą nowego kodu.
Jednak oto Minusem zmieniając stare, podobno bezsensowne komentarze w systemie, który jest utrzymywany przez grupę programistów:
Uwagi nie działają już jako komentarze! Działają one jako punkty orientacyjne dla programistów znających kod. Są to znaczące komentarze w przeciwieństwie do komentarzy wyjaśniających.
Programiści mogą rzeczywiście wyszukiwać słowa kluczowe w komentarzach orientacyjnych, aby nawigować po pliku.
Po usunięciu komentarzy dotyczących punktów orientacyjnych lub nawet ich zmianie można drastycznie spowolnić programistów, którzy używają ich do nawigacji w pliku. Denerwujesz się mentalnymi mapami ludzi, którzy mają długotrwały związek z kodem, i zadasz więcej obrażeń niż pożytku. Mózg to zabawna rzecz. Znacznie łatwiej jest zapamiętać słowo lub frazę za pomocą funkowego komentarza niż nazwa metody.
Wydaje mi się, że jeśli komentarze są niepoprawnie nieaktualne z kodem, powinieneś się dowiedzieć dlaczego. Wydaje się niewiarygodnie przypuszczać, że inni programiści nie dbają o kod. Może tak, może nie. Jeśli przejmujesz pliki od faceta, który odszedł, a masz wyraźne prawo własności, zagraj! Jeśli jesteś nowym facetem wśród grona facetów, którzy pracują nad kodem od 20 lat, a są jeszcze inne dowody na to, że oni się martwią o kod, być może czegoś brakuje.
Jest to podobne do ponownego formatowania - zmiana odstępów, zmiana miejsca, w którym otwierają się nawiasy klamrowe itp. I wiele zależy od własności.Czy będziesz w aktach 20 razy więcej niż facet obok ciebie? Lub 1/20 tak często? Jeśli to drugie, czy naprawdę chcesz go zdezorientować?
Upewnij się, że to nie jest to, co robisz, a jutro możesz usłyszeć, jak ktoś krzyczy: "Gdzie do cholery jest ta funkcja?"
powinna być wspólnota wiki – SilentGhost
Głosowałem, aby to zamknąć, ponieważ w ogóle nie rozumiem tego pytania. Jaka jest możliwa korzyść z pozostawienia komentarza w spokoju? Oczywiście wszyscy będą starali się je aktualizować. – mquander
Zakładasz, że powodem, dla którego komentarze nie zostały naprawione, jest to, że osoby zaangażowane w system nie dbają o to, aby je naprawić. Twierdzę, że komentarze, które mają długowieczność, mogą istnieć z jakiegoś powodu - są na tyle znajome, że służą do poruszania się w pliku, a nie do wyjaśniania działania kodu. – Nosredna