8장 주석자제하기

8 주석의 위험성

• 충분히 타입명과 변수명으로 표현가능 (-> 우리가 영어권 사람이면 공감될 듯)
• 주석은 컴파일러가 확인하지 않음(코드 수정 후 주석의 정확도를 판단할 수 없음)
• 오해의 소지가 있을 수 있음
• 미관상 더러움

💡 주석은 언제 지워야 할까?

• 작업흐름 상 리팩터링 단계에서 하면 좋음
• 코드가 표현할 수 없는것만 남기기

🔴 나쁜 주석

8-1 오래된 주석 제거

• 현재 코드와 동기화 되어있지 않을 수 있음
• 오해의 소지가 있을 수 있음

8-2 주석처리된 코드 제거

• !! 어차피 버전관리를 통해 관리되기 때문에 삭제 후에도 쉽게 복구가능! => 😊버전관리 툴을 잘 활용하자!
• 메인브랜치에 병합 전, 미리 삭제해두기

8-3 불필요한 주석 제거

• 사소한 거 다. 로그, 에러로그, 등등

8-4 메서드의 이름으로 주석 대신하기

• 😊chatGPT를 잘 활용해볼까

✅ 좋은 주석

8-4-1 계획을 위한 주석사용

• 나도 자주 애용하는 방법이라 공감이 갔다.
• 한번 적고 그 다음에 개발을 하면 무엇을 개발하려고 했는지 잘 떠올라서 좋음

# 변환하기
# for문 해당 객체 한번씩 convert_pdf_to_image 넣기
# 프로그래스바 삽입하기

8-5 불변속성을 문서화한 주석유지

• 나는 관용적으로 쓰이지 않는 매개변수의 의미나 히스토리가 없으면 알 수 없는 내용들을 적어두는 편
• 혹은 흐름을 알기 힘든 코드에 설명을 적는 듯(다른 코드와 연관이 깊은 코드)
• 그래도 웬만하면 함수명 타고타고 가다보면 흐름이 파악 되기는 해서 어느정도로 남겨야 할지는 고민!