AI는 주석을 너무 많이 남긴다.

일을 하면서 AI가 작성한 코드를 봤다. 코드가 10줄인데 주석이 40줄이다.

아니 뭐 아무리 주석을 단다고 해도 그렇지 너무한 거 아닌가 싶어 내용을 살펴보니 코드 외부의 문서의 특정 절이나 지라 티켓 이름을 참조한다.

가독성이 떨어지는 코드 + 과한 주석의 조합은 코드를 읽는 “사람”에게는 최악의 코드를 선물한다.

코드를 읽어서만은 의도를 알기가 어렵고, 주석은 혼돈을 야기시킨다.

AI로 한글 문서를 작성해봤다면, 여기저기에 영어 번역체의 어순 및 단어를 사용하고, 과한 수치화를 하는 등 한국인 독자가 읽기에 인지부하가 많이 발생하는 글을 쓴다는 걸 경험했을 가능성이 높다고 생각한다.

https://stackoverflow.blog/2021/12/23/best-practices-for-writing-code-comments/?cb=1