Day 28 - TIL

📘 Day 28 - Today I Learned

🔍 Today’s Error or Issue

코드를 작성할 때 주석을 다는 습관이 잘 들여져 있지 않다 보니, 코드에 대한 설명이 부족했다.
다른 분들의 코드리뷰를 참고하던 중 다양한 주석 유형들을 접하게 되었고, 이에 대해 알아보게 되었다.

🛠️ Troubleshooting

• Xcode에서 자주 사용되는 주석 포맷을 조사하고 정리했다.
• 실제 코드에 적용해보며 어떤 상황에서 어떤 주석을 쓰는 게 좋은지 파악했다.

📝 Learning Summary

주석 타입	형식 / 예시	설명
MARK:	// MARK: - 섹션 구분	파일 내 코드를 기능 단위로 나눌 때 사용, Xcode 내 접기/펼치기 가능
TODO:	// TODO: 로그인 로직 분리 예정	앞으로 구현하거나 수정할 작업 표시
FIXME:	// FIXME: 배열 인덱스 예외 처리 필요	지금 당장 고쳐야 할 버그나 임시 코드 표시
NOTE:	// NOTE: API 명세에 따라 변경 예정	참고해야 할 추가 설명
WARNING:	// WARNING: 순환 참조 발생 가능성 있음	주의가 필요한 로직 표시
HACK:	// HACK: 임시로 강제 캐스팅 처리함	임시방편 해결 코드 표시 (장기 유지 ❌)
OPTIMIZE:	// OPTIMIZE: 속도 개선 여지 있음	성능 개선 포인트 표시

📘 Lesson Learned

주석은 단순한 설명 이상의 역할을 한다.
적절한 주석은 코드의 가독성과 유지보수성을 높여주므로, 앞으로 의식적으로 좋은 주석 습관을 들이도록 노력하자!