What is self-documenting code and can it replace well documented code? [Zamknięte]

Mam kolegę, który upiera się, że jego kod nie wymaga komentarzy, to „samo dokumentowanie”.

Przejrzałem jego kod i chociaż jest to bardziej zrozumiałe niż kod, który widziałem w innych, nadal nie zgadzam się z tym, że samodokumentujący się kod jest tak samo kompletny i użyteczny, jak również skomentowany i udokumentowany kod.

Pomóż mi zrozumiećjego punkt widzenia.

Co to jest kod samodokumentującyCzy naprawdę może zastąpić dobrze skomentowany i udokumentowany kodCzy są sytuacje, w których jest lepszy niż dobrze udokumentowany i skomentowany kodCzy istnieją przykłady, w których kod nie może być samodokumentujący bez komentarzy

Może to tylko moje własne ograniczenia, ale nie wiem, jak to może być dobra praktyka.

To nie ma być argument - proszę nie podnosić powodów, dla których dobrze skomentowany i udokumentowany kod ma wysoki priorytet - jest wiele zasobów pokazujących to, ale nie są one przekonujące dla mojego rówieśnika. Uważam, że muszę lepiej zrozumieć jego perspektywę, aby przekonać go inaczej. Rozpocznij nowe pytanie, jeśli musisz, ale nie kłóć się tutaj.

Wow, szybka odpowiedź! Przeczytaj wszystkie istniejące odpowiedzi i przekaż komentarze do odpowiedzi zamiast dodawać nowe odpowiedzi, chyba że Twoja odpowiedź naprawdę różni się zasadniczo od każdej innej odpowiedzi tutaj.

Również ci z was, którzy spierają się przeciwko samodokumentującemu się kodowi - to przede wszystkim pomóc mi zrozumieć perspektywę (tj. Pozytywne aspekty) samodokumentujących się ewangelistów kodu. Spodziewam się, że inni cię obalą, jeśli nie będziesz na temat.

questionAnswers(30)

yourAnswerToTheQuestion