가독성·유지보수성 리뷰를 요청하는 프롬프트

언제 사용하나

동작은 맞지만 읽기 어렵거나 고치기 무서운 코드를 개선할 때.

요청 전 확인

• 팀의 코딩 컨벤션(있다면)을 함께 전달한다.

복사해서 쓰는 프롬프트

아래 코드를 가독성·유지보수성 관점으로 리뷰해줘.

{{CODE}}
컨벤션: {{CONVENTION}}

원하는 출력:
1. 이해를 방해하는 요소(모호한 이름, 깊은 중첩, 매직 넘버)
2. 우선순위가 높은 개선 3가지와 이유
3. 동작을 바꾸지 않는 구체적 리팩터링 예시
4. 과한 추상화 등 오히려 나빠질 수 있는 개선 경고

placeholder 설명

• {{CODE}} : 리뷰할 코드
• {{CONVENTION}} : 팀 컨벤션

입력 예시

{{CODE}} = 중첩 조건이 깊은 함수

기대 결과

가독성 저해 요소, 우선 개선 3가지, 리팩터링 예시.

검증 방법

개선안을 적용해도 테스트가 통과하는지 확인한다.

주의사항

• 취향 논쟁보다 이해·수정 비용에 근거해 판단한다.

관련 문서

• Clean Code 개요: https://google.github.io/styleguide/