„komentarze stają się nieaktualne”.
Widziałem to wystarczająco często, aby wiedzieć, że może to stanowić problem.
Chodzi o to, myślę, że widziałem może dwa lub trzy nieaktualne komentarze przez całą moją karierę.
Uważam, że praca w środowisku, w którym każdy dba o komentarze i je utrzymuje, powinna być całkowicie możliwa. To tylko niewielki dodatkowy wysiłek, aby spojrzeć na komentarze w pobliżu edytowanego kodu i zaktualizować je w razie potrzeby. Jeśli komentarze są tak daleko, że nie zauważysz ich od razu, i tak były to złe komentarze i nie powinny były zostać dodane (a przynajmniej ich nie ma).
Ponadto zwykle wraz ze stwierdzeniem, że komentarze stają się nieaktualne, następuje po stwierdzeniu, że zmniejsza to czytelność i dezorientuje ludzi. Tego jeszcze nie doświadczyłem. Za każdym razem, gdy napotykam nieaktualny komentarz, wyraźnie widzę, co się zmieniło, i po prostu odpowiednio aktualizuję komentarz, aby reprezentował nowszy kod, choć z pewnym dodatkowym wysiłkiem.
Ostatnie badanie Roehm i in. 2012 obserwuje następujące kwestie:
21 uczestników [z 28] zgłosiło, że uzyskuje swoje główne informacje z kodu źródłowego i umieszcza komentarze, podczas gdy tylko czterech twierdziło, że dokumentacja jest ich głównym źródłem informacji.
Jest to zgodne z twoim podejrzeniem, że komentarze w samym kodzie ogólnie są nadal uważane za bardzo przydatne. Wskazuje to na wyraźną granicę między nieaktualną dokumentacją a nieaktualnymi komentarzami .
Roehm, T., Tiarks, R., Koschke, R., i Maalej, W. (2012, June). Jak profesjonalni programiści rozumieją oprogramowanie ?. W materiałach z międzynarodowej konferencji na temat inżynierii oprogramowania z 2012 r. (Str. 255–265). IEEE Press.